| /* ==================================================================== |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| ==================================================================== */ |
| |
| package org.apache.poi.hssf.record; |
| |
| import java.util.Map; |
| import java.util.function.Supplier; |
| |
| import org.apache.poi.util.BitField; |
| import org.apache.poi.util.BitFieldFactory; |
| import org.apache.poi.util.GenericRecordUtil; |
| import org.apache.poi.util.LittleEndianOutput; |
| |
| /** |
| * Describes whether this is a protected shared/tracked workbook<p> |
| */ |
| public final class ProtectionRev4Record extends StandardRecord { |
| public static final short sid = 0x01AF; |
| |
| private static final BitField protectedFlag = BitFieldFactory.getInstance(0x0001); |
| |
| private int _options; |
| |
| private ProtectionRev4Record(int options) { |
| _options = options; |
| } |
| |
| private ProtectionRev4Record(ProtectionRev4Record other) { |
| super(other); |
| _options = other._options; |
| } |
| |
| public ProtectionRev4Record(boolean protect) { |
| this(0); |
| setProtect(protect); |
| } |
| |
| public ProtectionRev4Record(RecordInputStream in) { |
| this(in.readUShort()); |
| } |
| |
| /** |
| * set whether the this is protected shared/tracked workbook or not |
| * @param protect whether to protect the workbook or not |
| */ |
| public void setProtect(boolean protect) { |
| _options = protectedFlag.setBoolean(_options, protect); |
| } |
| |
| /** |
| * get whether the this is protected shared/tracked workbook or not |
| * @return whether to protect the workbook or not |
| */ |
| public boolean getProtect() { |
| return protectedFlag.isSet(_options); |
| } |
| |
| public void serialize(LittleEndianOutput out) { |
| out.writeShort(_options); |
| } |
| |
| protected int getDataSize() { |
| return 2; |
| } |
| |
| public short getSid() { |
| return sid; |
| } |
| |
| @Override |
| public ProtectionRev4Record copy() { |
| return new ProtectionRev4Record(this); |
| } |
| |
| |
| @Override |
| public HSSFRecordTypes getGenericRecordType() { |
| return HSSFRecordTypes.PROTECTION_REV_4; |
| } |
| |
| @Override |
| public Map<String, Supplier<?>> getGenericProperties() { |
| return GenericRecordUtil.getGenericProperties( |
| "options", () -> _options, |
| "protect", this::getProtect |
| ); |
| } |
| } |