maspack.properties

Interface PropertyInfoList

All Superinterfaces:

java.lang.Iterable<PropertyInfo>

All Known Implementing Classes:

FieldPropertyList, LocalPropertyList, PropertyList

public interface PropertyInfoList
extends java.lang.Iterable<PropertyInfo>

List containing information about a set of properties.

Method Summary

Modifier and Type	Method and Description
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.
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 interface java.lang.Iterable

forEach, spliterator

Method Detail

get

PropertyInfo get(java.lang.String name)

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

Parameters:

name - name of the property

Returns:

information for this property, if present

iterator

java.util.Iterator<PropertyInfo> iterator()

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

Specified by:

iterator in interface java.lang.Iterable<PropertyInfo>

Returns:

iterator for this list

size

int size()

Returns the number of properties described in this list.

Returns:

size of this list

hasNoInheritableProperties

boolean hasNoInheritableProperties()

Returns tree if any properties in this list are inheritable.

Returns:

true if list contains inheritable properties

writeNonDefaultProps

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.

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