Class PropertiesSection

java.lang.Object

org.refcodes.serial.AbstractPayloadSection<ImmutableProperties>

org.refcodes.serial.PropertiesSection

All Implemented Interfaces:

Serializable, AliasAccessor, EncodingAccessor<Charset>, LengthAccessor, PayloadAccessor<ImmutableProperties>, PayloadAccessor.PayloadBuilder<ImmutableProperties, PayloadTransmission<ImmutableProperties>>, PayloadAccessor.PayloadMutator<ImmutableProperties>, PayloadAccessor.PayloadProperty<ImmutableProperties>, Resetable, Diagnosable, Schemable<DiagnosticOptions>, PayloadSection<ImmutableProperties>, PayloadTransmission<ImmutableProperties>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

public class PropertiesSection
extends AbstractPayloadSection<ImmutableProperties>
implements Section, EncodingAccessor<Charset>

The PropertiesSection is an implementation of a Section carrying a String as payload.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface AliasAccessor

AliasAccessor.AliasBuilder<B>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface EncodingAccessor

EncodingAccessor.EncodingBuilder<E,B>, EncodingAccessor.EncodingMutator<E>, EncodingAccessor.EncodingProperty<E>

Nested classes/interfaces inherited from interface LengthAccessor

LengthAccessor.LengthBuilder<B>, LengthAccessor.LengthMutator, LengthAccessor.LengthProperty

Nested classes/interfaces inherited from interface PayloadAccessor

PayloadAccessor.PayloadBuilder<P,B>, PayloadAccessor.PayloadMutator<P>, PayloadAccessor.PayloadProperty<P>

Nested classes/interfaces inherited from interface Section

Section.SectionMixin

Nested classes/interfaces inherited from interface Transmission

Transmission.TransmissionMixin

Field Summary

Fields inherited from class AbstractPayloadSection

_alias, _payload

Constructor Summary

Constructors

Constructor	Description
PropertiesSection()	Constructs an empty PropertiesSection using UTF-8 encoding for the payload.
PropertiesSection(String aAlias)	Constructs an empty PropertiesSection using UTF-8 encoding for the payload.
PropertiesSection(String aAlias, Charset aCharset)	Constructs a PropertiesSection with a payload expected to be encoded with the given Charset.
PropertiesSection(String aAlias, ImmutableProperties aPayload)	Constructs a PropertiesSection with the given ImmutableProperties payload being UTF-8 encoded.
PropertiesSection(String aAlias, ImmutableProperties aPayload, Charset aCharset)	Constructs a PropertiesSection with the given ImmutableProperties payload being encoded with the given Charset.
PropertiesSection(String aAlias, ImmutableProperties aPayload, TransmissionMetrics aTransmissionMetrics)	Constructs a PropertiesSection with the given ImmutableProperties payload being encoded with the given Charset.
PropertiesSection(Charset aCharset)	Constructs a PropertiesSection with a payload expected to be encoded with the given Charset.
PropertiesSection(ImmutableProperties aPayload)	Constructs a PropertiesSection with the given ImmutableProperties payload being UTF-8 encoded.
PropertiesSection(ImmutableProperties aPayload, Charset aCharset)	Constructs a PropertiesSection with the given ImmutableProperties payload being encoded with the given Charset.
PropertiesSection(ImmutableProperties aPayload, TransmissionMetrics aTransmissionMetrics)	Constructs a PropertiesSection with the given ImmutableProperties payload being encoded with the given Charset.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
void	fromTransmission(Sequence aSequence, int aOffset, int aLength)	(Re-)initializes this instance with the the given Sequence data.
Charset	getEncoding()
int	getLength()	Determines the overall length of this Transmission.
int	hashCode()
Schema	toSchema()
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
SimpleTypeTable	toSimpleTypeTable()	Returns the ImmutableSimpleTypeTable representation of this Transmission.
PropertiesSection	withPayload(ImmutableProperties aValue)

Methods inherited from class AbstractPayloadSection

getAlias, getPayload, reset, setPayload, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface PayloadAccessor

getPayloadOr

Methods inherited from interface PayloadAccessor.PayloadProperty

letPayload

Methods inherited from interface Schemable

toSchema

Methods inherited from interface Section

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface Section.SectionMixin

receiveFrom

Methods inherited from interface Transmission

reset, transmitTo, transmitTo

Methods inherited from interface Transmission.TransmissionMixin

transmitTo

Constructor Details

PropertiesSection

public PropertiesSection(ImmutableProperties aPayload,
 TransmissionMetrics aTransmissionMetrics)

Constructs a PropertiesSection with the given ImmutableProperties payload being encoded with the given Charset. The properties from the payload are copied into the PropertiesSection. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aPayload - The payload to be contained by the Section.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

PropertiesSection

public PropertiesSection(String aAlias,
 ImmutableProperties aPayload,
 TransmissionMetrics aTransmissionMetrics)

Constructs a PropertiesSection with the given ImmutableProperties payload being encoded with the given Charset. The properties from the payload are copied into the PropertiesSection. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aAlias - The alias which identifies the content of this segment.

aPayload - The payload to be contained by the Section.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

PropertiesSection

public PropertiesSection()

Constructs an empty PropertiesSection using UTF-8 encoding for the payload.

PropertiesSection

public PropertiesSection(ImmutableProperties aPayload)

Constructs a PropertiesSection with the given ImmutableProperties payload being UTF-8 encoded. The properties from the payload are copied into the PropertiesSection.

Parameters:

aPayload - The payload to be contained by the Section.

PropertiesSection

public PropertiesSection(Charset aCharset)

Constructs a PropertiesSection with a payload expected to be encoded with the given Charset.

Parameters:

aCharset - The Charset to be used for encoding the String.

PropertiesSection

public PropertiesSection(ImmutableProperties aPayload,
 Charset aCharset)

Constructs a PropertiesSection with the given ImmutableProperties payload being encoded with the given Charset. The properties from the payload are copied into the PropertiesSection.

Parameters:

aPayload - The payload to be contained by the Section.

aCharset - The Charset to be used for encoding the String.

PropertiesSection

public PropertiesSection(String aAlias)

Constructs an empty PropertiesSection using UTF-8 encoding for the payload.

Parameters:

aAlias - The alias which identifies the content of this segment.

PropertiesSection

public PropertiesSection(String aAlias,
 ImmutableProperties aPayload)

Constructs a PropertiesSection with the given ImmutableProperties payload being UTF-8 encoded. The properties from the payload are copied into the PropertiesSection.

Parameters:

aAlias - The alias which identifies the content of this segment.

aPayload - The payload to be contained by the Section.

PropertiesSection

public PropertiesSection(String aAlias,
 Charset aCharset)

Constructs a PropertiesSection with a payload expected to be encoded with the given Charset.

Parameters:

aAlias - The alias which identifies the content of this segment.

aCharset - The Charset to be used for encoding the String.

PropertiesSection

public PropertiesSection(String aAlias,
 ImmutableProperties aPayload,
 Charset aCharset)

Constructs a PropertiesSection with the given ImmutableProperties payload being encoded with the given Charset. The properties from the payload are copied into the PropertiesSection.

Parameters:

aAlias - The alias which identifies the content of this segment.

aPayload - The payload to be contained by the Section.

aCharset - The Charset to be used for encoding the String.

Method Details

toSequence

public Sequence toSequence()

Provides the Sequence representation of this Transmission. In case of nested Transmission instances, all Sequence representations from all sub-segments are accumulated to the result as well. Caution, the Transmission (or its nested Transmission instances) may be backed by the returned Sequence.

Specified by:

toSequence in interface Transmission

Returns:

The according instance's Sequence.

fromTransmission

public void fromTransmission(Sequence aSequence,
 int aOffset,
 int aLength)
                      throws TransmissionException

(Re-)initializes this instance with the the given Sequence data.

Specified by:

fromTransmission in interface Section

Parameters:

aSequence - The Sequence data from which to (re-)initialize this instance.

aOffset - The offset where to start processing the provided Sequence.

aLength - The length of data assigned by the Sequence.

Throws:

TransmissionException - thrown in case a given Sequence cannot be processed.

getLength

public int getLength()

Determines the overall length of this Transmission. In case of nested Transmission instances, all length values from all sub-segments are accumulated to the result as well.

Specified by:

getLength in interface LengthAccessor

Specified by:

getLength in interface Transmission

Returns:

The (overall) length of the Transmission (including any sub-segments).

toSchema

public Schema toSchema()

Specified by:

toSchema in interface Schemable<DiagnosticOptions>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPayloadSection<ImmutableProperties>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractPayloadSection<ImmutableProperties>

withPayload

public PropertiesSection withPayload(ImmutableProperties aValue)

Specified by:

withPayload in interface PayloadAccessor.PayloadBuilder<ImmutableProperties, PayloadTransmission<ImmutableProperties>>

toSimpleTypeTable

public SimpleTypeTable toSimpleTypeTable()

Returns the ImmutableSimpleTypeTable representation of this Transmission. In case this Transmission has Transmission children, then the children are queried as well and contained in the resulting ImmutableSimpleTypeTable. The aliases of the according Transmission instances represent the resulting path to a Transmission's final simple type.

Specified by:

toSimpleTypeTable in interface Transmission

Overrides:

toSimpleTypeTable in class AbstractPayloadSection<ImmutableProperties>

Returns:

The ImmutableSimpleTypeTable representing this Transmission and (if any) its children, with the according aliases forming the paths to the Transmission's values.

getEncoding

public Charset getEncoding()

Specified by:

getEncoding in interface EncodingAccessor<Charset>