Module de.bernd_michaely.x3f.types

Package de.bernd_michaely.x3f.types

Class X3fPropertyList

java.lang.Object

de.bernd_michaely.x3f.types.X3fPropertyList

public class X3fPropertyList
extends Object

Class for representing the property list contained in X3F data. Several property list sections will be combined in one single property list.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	X3fPropertyList.X3fPropertyListHeader	Class for representing a property list header contained in X3F data.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	X3fPropertyList()	Constructor for X3F property list.

Method Summary

Modifier and Type	Method	Description
List<X3fPropertyList.X3fPropertyListHeader>	getX3fPropertyListHeaders()	Returns a list of X3F property list headers.
String	getX3fPropertyNameDescription(String propertyName)
String[]	getX3fPropertyNames()	Returns a sorted list of X3F property names.
String	getX3fPropertyValueDescription(String propertyName)	Returns a descriptive value of the given property or null, if it does not exist.
String	getX3fPropertyValueRaw(String propertyName)	Returns the raw value of the given property or null, if it does not exist.
Calendar	getX3fTime()
Calendar	getX3fTime(Locale locale)
void	read(RandomAccessData data)	Method to parse and collect information contained in a X3F property list.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

X3fPropertyList

protected X3fPropertyList()

Constructor for X3F property list.

Method Detail

getX3fPropertyListHeaders

public List<X3fPropertyList.X3fPropertyListHeader> getX3fPropertyListHeaders()

Returns a list of X3F property list headers.

Returns:

a list of X3F property list headers

getX3fPropertyNames

public String[] getX3fPropertyNames()

Returns a sorted list of X3F property names.

Returns:

a sorted list of X3F property names

getX3fPropertyNameDescription

public String getX3fPropertyNameDescription(String propertyName)

getX3fPropertyValueRaw

public String getX3fPropertyValueRaw(String propertyName)

Returns the raw value of the given property or null, if it does not exist.

Parameters:

propertyName - the property name to search for

Returns:

the raw value of the given property or null

getX3fPropertyValueDescription

public String getX3fPropertyValueDescription(String propertyName)

Returns a descriptive value of the given property or null, if it does not exist.

Parameters:

propertyName - the property name to search for

Returns:

a descriptive value of the given property or null

getX3fTime

public Calendar getX3fTime()

getX3fTime

public Calendar getX3fTime(Locale locale)

read

public void read(RandomAccessData data)
          throws RandomAccessDataException

Method to parse and collect information contained in a X3F property list. It is assumed, that the current offset pointer of the data source is positioned just after the property list section identifier "SECp".

Parameters:

data - the data source containing the X3F data to parse

Throws:

RandomAccessDataException - if RandomAccessData source is invalid

toString

public String toString()

Overrides:

toString in class Object