org.jostraca.unit
Interface Unit

All Known Implementing Classes:

BasicUnit

public interface Unit

Description:
A Unit is a processing entity for creating CodeWriters. Units are processed sequentially into a SectionSet. Units are immutable. If you want to change units, transform the current set into a new set and continue.

See Also:

UnitList

Method Summary

java.util.Hashtable	getAttributes() Return attributes of Unit.
java.lang.String	getContent() Return content of Unit.
UnitOrigin	getOrigin() Return origin description of Unit.
java.lang.String	getSection() Return section name of Unit.
java.lang.String	getType() Return type name of Unit.

Method Detail

getContent

public java.lang.String getContent()

Return content of Unit. Contract: does not return null, may return empty String.

getType

public java.lang.String getType()

Return type name of Unit. Contract: does not return null, may return empty String.

getSection

public java.lang.String getSection()

Return section name of Unit. Contract: does not return null, may return empty String.

getOrigin

public UnitOrigin getOrigin()

Return origin description of Unit. Contract: does not return null.

getAttributes

public java.util.Hashtable getAttributes()

Return attributes of Unit. Some types of Unit may have these, such as 'insert-section', which has attribute 'source-section'. This is maily provided for backwards compatibility and should not be used where better alternatives exist. Contract: does not return null, returns a copy.