maspack.properties

Class LocalPropertyList

java.lang.Object

maspack.properties.LocalPropertyList

All Implemented Interfaces:

java.lang.Iterable<PropertyInfo>, PropertyInfoList

public class LocalPropertyList
extends java.lang.Object
implements PropertyInfoList

Implements a local property list that allows the addition of properties which are specific to a class-instance.

Constructor Summary

Constructors

Constructor and Description
LocalPropertyList()
LocalPropertyList(PropertyList classProps)

Method Summary

Modifier and Type	Method and Description
void	add(PropertyInfo info)
PropertyDesc	add(java.lang.String name, java.lang.String methods, java.lang.Object key, java.lang.String description, java.lang.Object defaultValue)
PropertyDesc	add(java.lang.String name, java.lang.String methods, java.lang.Object key, java.lang.String description, java.lang.Object defaultValue, java.lang.String options)
PropertyInfo	get(java.lang.String name) Gets information for a specific named property.
boolean	hasNoInheritableProperties() Returns tree if any properties in this list are inheritable.
java.util.Iterator<PropertyInfo>	iterator() Returns an iterator over all PropertyInfo structures contained in this list.
boolean	remove(java.lang.String name)
int	size() Returns the number of properties described in this list.
boolean	writeNonDefaultProps(HasProperties host, java.io.PrintWriter pw, NumberFormat fmt, java.lang.Object ref) Writes properties in this list whose current values differ from their default values to a PrintWriter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

LocalPropertyList

public LocalPropertyList(PropertyList classProps)

LocalPropertyList

public LocalPropertyList()

Method Detail

get

public PropertyInfo get(java.lang.String name)

Description copied from interface: PropertyInfoList

Gets information for a specific named property. If the named property is not defined in this list, null is returned.

Specified by:

get in interface PropertyInfoList

Parameters:

name - name of the property

Returns:

information for this property, if present

iterator

public java.util.Iterator<PropertyInfo> iterator()

Description copied from interface: PropertyInfoList

Returns an iterator over all PropertyInfo structures contained in this list.

Specified by:

iterator in interface java.lang.Iterable<PropertyInfo>

Specified by:

iterator in interface PropertyInfoList

Returns:

iterator for this list

size

public int size()

Description copied from interface: PropertyInfoList

Returns the number of properties described in this list.

Specified by:

size in interface PropertyInfoList

Returns:

size of this list

hasNoInheritableProperties

public boolean hasNoInheritableProperties()

Description copied from interface: PropertyInfoList

Returns tree if any properties in this list are inheritable.

Specified by:

hasNoInheritableProperties in interface PropertyInfoList

Returns:

true if list contains inheritable properties

add

public PropertyDesc add(java.lang.String name,
                        java.lang.String methods,
                        java.lang.Object key,
                        java.lang.String description,
                        java.lang.Object defaultValue,
                        java.lang.String options)

add

public PropertyDesc add(java.lang.String name,
                        java.lang.String methods,
                        java.lang.Object key,
                        java.lang.String description,
                        java.lang.Object defaultValue)

add

public void add(PropertyInfo info)

remove

public boolean remove(java.lang.String name)

writeNonDefaultProps

public boolean writeNonDefaultProps(HasProperties host,
                                    java.io.PrintWriter pw,
                                    NumberFormat fmt,
                                    java.lang.Object ref)
                             throws java.io.IOException

Writes properties in this list whose current values differ from their default values to a PrintWriter. This allows the conservation of space within persistent storage. Otherwise, the behaviour of this method is identical to PropertyList.writeProps(maspack.properties.HasProperties, java.io.PrintWriter, maspack.util.NumberFormat, java.lang.Object); in particular only those properties for which PropertyInfo.getAutoWrite returns true are written.

Specified by:

writeNonDefaultProps in interface PropertyInfoList

Parameters:

host - class exporting the properties

pw - PrintWriter to which properties are written

fmt - Numeric formatting information. This is only used when the value to be written is itself Scannable, in which case it is passed to that value's write method.

ref - Reference object. This is only used when the value to be written is itself Scannable, in which case it is passed to that value's write method.

Throws:

java.io.IOException - if an I/O error occurred writing to the stream