Apache POI - Common 5.3.0 · org.apache.poi.ddf.EscherSimpleProperty

Modifier and Type	Field and Description
private final int	propertyValue

Constructor Summary

Access	Constructor and Description
public	EscherSimpleProperty(short the property id id, int the property value propertyValue) The id is distinct from the actual property number.
public	EscherSimpleProperty(EscherPropertyTypes the property type type, int the property value propertyValue) The id is distinct from the actual property number.
public	EscherSimpleProperty(short the property number propertyNumber, boolean true, if its a complex property isComplex, boolean true, if its a blip isBlipId, int the property value propertyValue) Constructs a new escher property.
public	EscherSimpleProperty(EscherPropertyTypes one of the defined property types type, boolean true, if its a complex property isComplex, boolean true, if its a blip isBlipId, int the property value propertyValue) Constructs a new escher property.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Returns true if one escher property is equal to another.
public Map<String, Supplier<?>>	getGenericProperties() Overrides org.apache.poi.ddf.EscherProperty.getGenericProperties. Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public int	Returns: Return the 32 bit value of this property. getPropertyValue()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hashcode so that this object can be stored in collections that require the use of such things.
public int	serializeComplexPart(byte[] the buffer to write to data, int the starting position pos) Implements abstract org.apache.poi.ddf.EscherProperty.serializeComplexPart. Escher properties consist of a simple fixed length part and a complex variable length part.
public int	Returns: the number of bytes serialized. serializeSimplePart(byte[] the buffer to write to data, int the starting position offset) Implements abstract org.apache.poi.ddf.EscherProperty.serializeSimplePart. Serialize the simple part of the escher record.

Inherited from org.apache.poi.ddf.EscherProperty:: getGenericChildren getGenericRecordType getId getName getPropertyNumber getPropertySize isBlipId isComplex toString toXml

Field Detail

propertyValue	back to summary
private final int propertyValue

Constructor Detail

EscherSimpleProperty	back to summary
public EscherSimpleProperty(short id, int propertyValue) The id is distinct from the actual property number. The id includes the property number the blip id flag and an indicator whether the property is complex or not. Parameters id:short the property id propertyValue:int the property value

EscherSimpleProperty

back to summary

public EscherSimpleProperty(short id, int propertyValue)

The id is distinct from the actual property number. The id includes the property number the blip id flag and an indicator whether the property is complex or not.

Parameters

id:short: the property id
propertyValue:int: the property value

EscherSimpleProperty	back to summary
public EscherSimpleProperty(EscherPropertyTypes type, int propertyValue) The id is distinct from the actual property number. The id includes the property number the blip id flag and an indicator whether the property is complex or not. Parameters type:EscherPropertyTypes the property type propertyValue:int the property value

EscherSimpleProperty

back to summary

public EscherSimpleProperty(EscherPropertyTypes type, int propertyValue)

The id is distinct from the actual property number. The id includes the property number the blip id flag and an indicator whether the property is complex or not.

Parameters

type:EscherPropertyTypes: the property type
propertyValue:int: the property value

EscherSimpleProperty	back to summary
public EscherSimpleProperty(short propertyNumber, boolean isComplex, boolean isBlipId, int propertyValue) Constructs a new escher property. The three parameters are combined to form a property id. Parameters propertyNumber:short the property number isComplex:boolean true, if its a complex property isBlipId:boolean true, if its a blip propertyValue:int the property value

EscherSimpleProperty

back to summary

public EscherSimpleProperty(short propertyNumber, boolean isComplex, boolean isBlipId, int propertyValue)

Constructs a new escher property. The three parameters are combined to form a property id.

Parameters

propertyNumber:short: the property number
isComplex:boolean: true, if its a complex property
isBlipId:boolean: true, if its a blip
propertyValue:int: the property value

EscherSimpleProperty	back to summary
public EscherSimpleProperty(EscherPropertyTypes type, boolean isComplex, boolean isBlipId, int propertyValue) Constructs a new escher property. The three parameters are combined to form a property id. Parameters type:EscherPropertyTypes one of the defined property types isComplex:boolean true, if its a complex property isBlipId:boolean true, if its a blip propertyValue:int the property value

EscherSimpleProperty

back to summary

public EscherSimpleProperty(EscherPropertyTypes type, boolean isComplex, boolean isBlipId, int propertyValue)

Constructs a new escher property. The three parameters are combined to form a property id.

Parameters

type:EscherPropertyTypes: one of the defined property types
isComplex:boolean: true, if its a complex property
isBlipId:boolean: true, if its a blip
propertyValue:int: the property value

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Returns true if one escher property is equal to another. Parameters o:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Returns true if one escher property is equal to another.

Parameters

o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Overrides org.apache.poi.ddf.EscherProperty.getGenericProperties. Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Overrides org.apache.poi.ddf.EscherProperty.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getPropertyValue	back to summary
public int getPropertyValue() Returns:int Return the 32 bit value of this property.

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hashcode so that this object can be stored in collections that require the use of such things. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hashcode so that this object can be stored in collections that require the use of such things.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

serializeComplexPart	back to summary
public int serializeComplexPart(byte[] data, int pos) Implements abstract org.apache.poi.ddf.EscherProperty.serializeComplexPart. Escher properties consist of a simple fixed length part and a complex variable length part. The fixed length part is serialized first. Parameters data:byte[] Doc from org.apache.poi.ddf.EscherProperty.serializeComplexPart. the buffer to write to pos:int Doc from org.apache.poi.ddf.EscherProperty.serializeComplexPart. the starting position Returns:int Doc from org.apache.poi.ddf.EscherProperty.serializeComplexPart. the length of the part Annotations @Override

serializeComplexPart

back to summary

public int serializeComplexPart(byte[] data, int pos)

Implements abstract org.apache.poi.ddf.EscherProperty.serializeComplexPart.

Escher properties consist of a simple fixed length part and a complex variable length part. The fixed length part is serialized first.

Parameters

data:byte[]

Doc from org.apache.poi.ddf.EscherProperty.serializeComplexPart.

the buffer to write to

pos:int

Doc from org.apache.poi.ddf.EscherProperty.serializeComplexPart.

the starting position

Returns:int

Doc from org.apache.poi.ddf.EscherProperty.serializeComplexPart.

the length of the part

Annotations

@Override

serializeSimplePart	back to summary
public int serializeSimplePart(byte[] data, int offset) Implements abstract org.apache.poi.ddf.EscherProperty.serializeSimplePart. Serialize the simple part of the escher record. Parameters data:byte[] Doc from org.apache.poi.ddf.EscherProperty.serializeSimplePart. the buffer to write to offset:int Doc from org.apache.poi.ddf.EscherProperty.serializeSimplePart. the starting position Returns:int the number of bytes serialized. Annotations @Override

serializeSimplePart

back to summary

public int serializeSimplePart(byte[] data, int offset)

Implements abstract org.apache.poi.ddf.EscherProperty.serializeSimplePart.

Serialize the simple part of the escher record.

Parameters

data:byte[]

Doc from org.apache.poi.ddf.EscherProperty.serializeSimplePart.

the buffer to write to

offset:int

Doc from org.apache.poi.ddf.EscherProperty.serializeSimplePart.

the starting position