org.apache.poi.hssf.record.ProtectionRev4Record Maven / Gradle / Ivy
/* ====================================================================
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 org.apache.poi.util.LittleEndian;
/**
* Title: Protection Revision 4 Record
* Description: describes whether this is a protected shared/tracked workbook
* ( HSSF does not support encryption because we don't feel like going to jail )
* REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
* @author Andrew C. Oliver (acoliver at apache dot org)
* @version 2.0-pre
*/
public class ProtectionRev4Record
extends Record
{
public final static short sid = 0x1af;
private short field_1_protect;
public ProtectionRev4Record()
{
}
/**
* Constructs a ProtectionRev4 record and sets its fields appropriately.
*
* @param id id must be 0x1af or an exception will be throw upon validation
* @param size the size of the data area of the record
* @param data data of the record (should not contain sid/len)
*/
public ProtectionRev4Record(RecordInputStream in)
{
super(in);
}
protected void validateSid(short id)
{
if (id != sid)
{
throw new RecordFormatException("NOT A PROTECTION REV 4 RECORD");
}
}
protected void fillFields(RecordInputStream in)
{
field_1_protect = in.readShort();
}
/**
* 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)
{
if (protect)
{
field_1_protect = 1;
}
else
{
field_1_protect = 0;
}
}
/**
* get whether the this is protected shared/tracked workbook or not
* @return whether to protect the workbook or not
*/
public boolean getProtect()
{
return (field_1_protect == 1);
}
public String toString()
{
StringBuffer buffer = new StringBuffer();
buffer.append("[PROT4REV]\n");
buffer.append(" .protect = ").append(getProtect())
.append("\n");
buffer.append("[/PROT4REV]\n");
return buffer.toString();
}
public int serialize(int offset, byte [] data)
{
LittleEndian.putShort(data, 0 + offset, sid);
LittleEndian.putShort(data, 2 + offset,
(( short ) 0x02)); // 2 bytes (6 total)
LittleEndian.putShort(data, 4 + offset, field_1_protect);
return getRecordSize();
}
public int getRecordSize()
{
return 6;
}
public short getSid()
{
return sid;
}
}