PlistProperties

java.lang.Object
- plistreader.PlistProperties

```
public class PlistProperties
extends Object
```
Title: PlistReader PlistProperties

Description: Package to read and write PLIST files on OsX

Copyright: 2007, Gie Spaepen

Company: University of Antwerp

When you read a PLIST file you'll work afterwards with this class. This object holds all the data structured as key - value pairs. Some functions show similarity with the java.util.Properties class but this class doesn't inherit from that class for the simple reason that a Properties class extends a java.util.Hashtable and that's not flexible enough.

The keys are always strings and the values can be instance of the following classes (all non-primitive):
- String
- Integer
- Double
- Date
- Boolean
- Byte
- PlistProperties
- Vector (which can contain the6 other classes mentioned)
All of these classes are translations of the XML code:
- string tag: String
- integer tag: Integer
- real tag: Double
- date tag: Date
- true or false flag: Boolean
- data tag: Byte
- dict tag: PlistProperties
- array tag: Vector
Scroll on to the functions for the usage
Version:

1.2

Author:

Gie Spaepen

Field Summary

Fields
Modifier and Type	Field and Description
`private Vector`	`internalKeys` Stores all the key values
`private Vector`	`internalValues` Stores all the values of the keys
`private String`	`key` Stores the key of this object itselves
`static Class`	`TYPE_ARRAY` Class object for a Vector (follows `PLIST` syntax)
`static Class`	`TYPE_BOOLEAN` Class object for a Boolean
`static Class`	`TYPE_DATA` Class object for a Byte[]
`static Class`	`TYPE_DATE` Class object for a Date
`static Class`	`TYPE_DICTIONARY` Alias for a `TYPE_PLISTPROPERTIES` (follows `PLIST` syntax)
`static Class`	`TYPE_DOUBLE` Class object for a Double
`static Class`	`TYPE_INTEGER` Class object for an Integer
`static Class`	`TYPE_PLISTPROPERTIES` Class object for a PlistProperties
`static Class`	`TYPE_STRING` Class object for a String
`static Class`	`TYPE_VECTOR` Alias for a `TYPE_ARRAY`

Constructor Summary

Constructors
Constructor and Description

PlistProperties()
Empty constructor

PlistProperties(String _key)
Construct a PlistProperties object with a specific key

Constructors
Constructor and Description
`PlistProperties()` Empty constructor
`PlistProperties(String _key)` Construct a `PlistProperties` object with a specific key

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeProperty(String _key, Object _value)` Change the value of a given key `_key` to a value `_value`.
`static PlistProperties`	`convertToPlistProperties(Properties _props)`
`Properties`	`convertToProperties()` This function converts a `PlistPropertiesObject` to a regular `java.util.Properties` object.
`static Properties`	`convertToProperties(PlistProperties _props)`
`int`	`getKeyIndex(String _key)` Get the index of a key.
`Vector`	`getKeys()` Get the `Vector` of all the kyes
`String`	`getPropertiesKey()` Get the key of this object
`Object`	`getProperty(String _key)` Search a property value for a given key.
`Object`	`getProperty(String _key, Object _default)` Get the value of a given key and return the `_default` object if nothing is found.
`Object`	`getPropertyRecursive(String _key)` Search a property value for a given key.
`Vector`	`getValues()` Get the `Vector` of all the values
`void`	`list(PrintStream _out)` This function prints the contents of this object to a Printstream `_out`.
`void`	`list(PrintStream _out, int _tabIndex)` This function prints the contents of this object to a Printstream `_out`.
`void`	`list(PrintWriter _out)` This function prints the contents of this object to a Printstream `_out`.
`void`	`list(PrintWriter _out, int _tabIndex)` This function prints the contents of this object to a PrintWriter `_out`.
`private void`	`printContent(Object _out, int _tabIndex)` This function handles the actions described in the various `list()` functions in this document.
`int`	`propertyTypeCount(Class _type)` Get the number of properties belonging to a certain type.
`int`	`propertyTypeCount(Class _type, int _baseCount)` Get the number of properties belonging to a certain type.
`void`	`setPropertiesKey(String _key)` Set the key of this object
`void`	`setProperty(String _key, Object _value)` Set the value of a given key `_key` to a value `_value`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - internalKeys
```
private Vector internalKeys
```
    Stores all the key values
  - internalValues
```
private Vector internalValues
```
    Stores all the values of the keys
  - key
```
private String key
```
    Stores the key of this object itselves
  - TYPE_STRING
```
public static final Class TYPE_STRING
```
    Class object for a String
  - TYPE_INTEGER
```
public static final Class TYPE_INTEGER
```
    Class object for an Integer
  - TYPE_DOUBLE
```
public static final Class TYPE_DOUBLE
```
    Class object for a Double
  - TYPE_DATE
```
public static final Class TYPE_DATE
```
    Class object for a Date
  - TYPE_DATA
```
public static final Class TYPE_DATA
```
    Class object for a Byte[]
  - TYPE_BOOLEAN
```
public static final Class TYPE_BOOLEAN
```
    Class object for a Boolean
  - TYPE_ARRAY
```
public static final Class TYPE_ARRAY
```
    Class object for a Vector (follows PLIST syntax)
  - TYPE_VECTOR
```
public static final Class TYPE_VECTOR
```
    Alias for a TYPE_ARRAY
    
    See Also:
    
    TYPE_VECTOR
  - TYPE_PLISTPROPERTIES
```
public static final Class TYPE_PLISTPROPERTIES
```
    Class object for a PlistProperties
  - TYPE_DICTIONARY
```
public static final Class TYPE_DICTIONARY
```
    Alias for a TYPE_PLISTPROPERTIES (follows PLIST syntax)
    
    See Also:
    
    TYPE_PLISTPROPERTIES
- Constructor Detail
  - PlistProperties
```
public PlistProperties()
```
    Empty constructor
  - PlistProperties
```
public PlistProperties(String _key)
```
    Construct a PlistProperties object with a specific key
    
    Parameters:
    
    _key - String
- Method Detail
  - getProperty
```
public Object getProperty(String _key)
                   throws PlistReaderException
```
    Search a property value for a given key. The function returns an exception when nothing is found.
    
    Parameters:
    
    _key - String
    
    Returns:
    
    Object
    
    Throws:
    
    PlistReaderException
  - getKeyIndex
```
public int getKeyIndex(String _key)
```
    Get the index of a key. When nothing is found the function returns -1.
    
    Parameters:
    
    _key - String
    
    Returns:
    
    int
  - getPropertyRecursive
```
public Object getPropertyRecursive(String _key)
                            throws PlistReaderException
```
    Search a property value for a given key. When this object contains other PlistProperties objects, they will also be searched.
    
    Parameters:
    
    _key - String
    
    Returns:
    
    Object
    
    Throws:
    
    PlistReaderException
  - setPropertiesKey
```
public void setPropertiesKey(String _key)
```
    Set the key of this object
    
    Parameters:
    
    _key - String
  - getPropertiesKey
```
public String getPropertiesKey()
```
    Get the key of this object
    
    Returns:
    
    String
  - getProperty
```
public Object getProperty(String _key,
                          Object _default)
```
    Get the value of a given key and return the _default object if nothing is found. This function is not recursive.
    
    Parameters:
    
    _key - String
    
    _default - Object
    
    Returns:
    
    Object
  - setProperty
```
public void setProperty(String _key,
                        Object _value)
                 throws PlistReaderException
```
    Set the value of a given key _key to a value _value. This function generates an error if the wrong key is given. If the key exists its value is changed. Otherwise a new element is added.
    
    Parameters:
    
    _key - String
    
    _value - Object
    
    Throws:
    
    PlistReaderException
  - changeProperty
```
public void changeProperty(String _key,
                           Object _value)
                    throws PlistReaderException
```
    Change the value of a given key _key to a value _value. The difference with the setProperty function is the fact that this function throws an exception when no key is found instead of adding a new node.
    
    Parameters:
    
    _key - String
    
    _value - Object
    
    Throws:
    
    PlistReaderException
  - propertyTypeCount
```
public int propertyTypeCount(Class _type)
```
    Get the number of properties belonging to a certain type. For example if you want to know how many elements there are into the PlistProperties object of the type String (equals to a <string> tag you can call this function. As parameter _type you can use the static fields of this class:
    - TYPE_STRING
    - TYPE_INTEGER
    - TYPE_DOUBLE
    - TYPE_DATE
    - TYPE_DATA
    - TYPE_BOOLEAN
    - TYPE_ARRAY
    - TYPE_VECTOR
    - TYPE_PLISTPROPERTIES
    - TYPE_DICTIONARY
    Parameters:
    
    _type - Class
    
    Returns:
    
    int
  - propertyTypeCount
```
public int propertyTypeCount(Class _type,
                             int _baseCount)
```
    Get the number of properties belonging to a certain type. See propertyTypeCount(Class _type) for more information. The only difference with that previous function is the fact that the counting doesn't start from 0 but from _baseCount.
    
    Parameters:
    
    _type - Class
    
    _baseCount - int
    
    Returns:
    
    int
  - convertToProperties
```
public Properties convertToProperties()
```
    This function converts a PlistPropertiesObject to a regular java.util.Properties object. Only the first-level childs of the root dict node are converted to String-String key-value pairs. Nested arrays or dictionaries are not added to the Properties object.
    
    Returns:
    
    Properties
  - convertToProperties
```
public static Properties convertToProperties(PlistProperties _props)
```
  - convertToPlistProperties
```
public static PlistProperties convertToPlistProperties(Properties _props)
```
  - list
```
public void list(PrintStream _out)
```
    This function prints the contents of this object to a Printstream _out. An '-' means an element of this object and '+' refers to elements of an array.
    
    Parameters:
    
    _out - PrintStream
    
    See Also:
    
    list(PrintStream _out, int _tabIndex)
  - list
```
public void list(PrintWriter _out)
```
    This function prints the contents of this object to a Printstream _out. An '-' means an element of this object and '+' refers to elements of an array.
    
    Parameters:
    
    _out - PrintStream
    
    See Also:
    
    list(PrintStream _out, int _tabIndex)
  - list
```
public void list(PrintStream _out,
                 int _tabIndex)
```
    This function prints the contents of this object to a Printstream _out. An '-' means an element of this object and '+' refers to elements of an array. With the integer _tabIndex you can d define the indentation of the text.
    
    Parameters:
    
    _out - PrintStream
    
    _tabIndex - int - the left indentation
    
    See Also:
    
    list(PrintStream _out)
  - list
```
public void list(PrintWriter _out,
                 int _tabIndex)
```
    This function prints the contents of this object to a PrintWriter _out. An '-' means an element of this object and '+' refers to elements of an array. With the integer _tabIndex you can d define the indentation of the text.
    
    Parameters:
    
    _out - PrintStream
    
    _tabIndex - int - the left indentation
    
    See Also:
    
    list(PrintWriter _out)
  - printContent
```
private void printContent(Object _out,
                          int _tabIndex)
                   throws PlistReaderException
```
    This function handles the actions described in the various list() functions in this document. Because printWriter and PrintStream have for the list() functions the same method syntax these methods are blended to this function using some aspects of java.lang.reflect to print it to the resp. streams.
    
    Parameters:
    
    _out - Object
    
    _tabIndex - int
    
    Throws:
    
    PlistReaderException
  - getKeys
```
public Vector getKeys()
```
    Get the Vector of all the kyes
    
    Returns:
    
    Vector
  - getValues
```
public Vector getValues()
```
    Get the Vector of all the values
    
    Returns:
    
    Vector

Class PlistProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

internalKeys

internalValues

key

TYPE_STRING

TYPE_INTEGER

TYPE_DOUBLE

TYPE_DATE

TYPE_DATA

TYPE_BOOLEAN

TYPE_ARRAY

TYPE_VECTOR

TYPE_PLISTPROPERTIES

TYPE_DICTIONARY

Constructor Detail

PlistProperties

PlistProperties

Method Detail

getProperty

getKeyIndex

getPropertyRecursive

setPropertiesKey

getPropertiesKey

getProperty

setProperty

changeProperty

propertyTypeCount

propertyTypeCount

convertToProperties

convertToProperties

convertToPlistProperties

list

list

list

list

printContent

getKeys

getValues