- java.lang.Object
-
- org.refcodes.serial.AbstractPayloadSection<org.refcodes.properties.Properties>
-
- org.refcodes.serial.PropertiesSection
-
- All Implemented Interfaces:
Serializable
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.EncodingAccessor<Charset>
,org.refcodes.mixin.LengthAccessor
,org.refcodes.mixin.PayloadAccessor<org.refcodes.properties.Properties>
,org.refcodes.mixin.PayloadAccessor.PayloadBuilder<org.refcodes.properties.Properties,PayloadTransmission<org.refcodes.properties.Properties>>
,org.refcodes.mixin.PayloadAccessor.PayloadMutator<org.refcodes.properties.Properties>
,org.refcodes.mixin.PayloadAccessor.PayloadProperty<org.refcodes.properties.Properties>
,PayloadSection<org.refcodes.properties.Properties>
,PayloadTransmission<org.refcodes.properties.Properties>
,Section
,Section.SectionMixin
,Transmission
,Transmission.TransmissionMixin
public class PropertiesSection extends AbstractPayloadSection<org.refcodes.properties.Properties> implements Section, org.refcodes.mixin.EncodingAccessor<Charset>
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor
org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.EncodingAccessor
org.refcodes.mixin.EncodingAccessor.EncodingBuilder<E extends Object,B extends org.refcodes.mixin.EncodingAccessor.EncodingBuilder<E,B>>, org.refcodes.mixin.EncodingAccessor.EncodingMutator<E extends Object>, org.refcodes.mixin.EncodingAccessor.EncodingProperty<E extends Object>
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.LengthAccessor
org.refcodes.mixin.LengthAccessor.LengthBuilder<B extends org.refcodes.mixin.LengthAccessor.LengthBuilder<B>>, org.refcodes.mixin.LengthAccessor.LengthMutator, org.refcodes.mixin.LengthAccessor.LengthProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.PayloadAccessor
org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P extends Object,B extends org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P,B>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<P extends Object>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<P extends Object>
-
Nested classes/interfaces inherited from interface org.refcodes.serial.Section
Section.SectionMixin
-
Nested classes/interfaces inherited from interface org.refcodes.serial.Transmission
Transmission.TransmissionMixin
-
-
Field Summary
-
Fields inherited from class org.refcodes.serial.AbstractPayloadSection
_alias, _payload
-
-
Constructor Summary
Constructors Constructor Description PropertiesSection()
Constructs an emptyPropertiesSection
using UTF-8 encoding for the payload.PropertiesSection(String aAlias)
Constructs an emptyPropertiesSection
using UTF-8 encoding for the payload.PropertiesSection(String aAlias, Charset aCharset)
Constructs aPropertiesSection
with a payload expected to be encoded with the givenCharset
.PropertiesSection(String aAlias, org.refcodes.properties.Properties aPayload)
Constructs aPropertiesSection
with the givenProperties
payload being UTF-8 encoded.PropertiesSection(String aAlias, org.refcodes.properties.Properties aPayload, Charset aCharset)
Constructs aPropertiesSection
with the givenProperties
payload being encoded with the givenCharset
.PropertiesSection(String aAlias, org.refcodes.properties.Properties aPayload, TransmissionMetrics aTransmissionMetrics)
Constructs aPropertiesSection
with the givenProperties
payload being encoded with the givenCharset
.PropertiesSection(Charset aCharset)
Constructs aPropertiesSection
with a payload expected to be encoded with the givenCharset
.PropertiesSection(org.refcodes.properties.Properties aPayload)
Constructs aPropertiesSection
with the givenProperties
payload being UTF-8 encoded.PropertiesSection(org.refcodes.properties.Properties aPayload, Charset aCharset)
Constructs aPropertiesSection
with the givenProperties
payload being encoded with the givenCharset
.PropertiesSection(org.refcodes.properties.Properties aPayload, TransmissionMetrics aTransmissionMetrics)
Constructs aPropertiesSection
with the givenProperties
payload being encoded with the givenCharset
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
void
fromTransmission(Sequence aSequence, int aOffset, int aLength)
(Re-)initializes this instance with the the givenSequence
data.Charset
getEncoding()
int
getLength()
Determines the overall length of thisTransmission
.int
hashCode()
Schema
toSchema()
Retrieves theSchema
representing theTransmission
.Sequence
toSequence()
Provides theSequence
representation of thisTransmission
.org.refcodes.struct.SimpleTypeMap
toSimpleTypeMap()
Returns theSimpleTypeMap
representation of thisTransmission
.PropertiesSection
withPayload(org.refcodes.properties.Properties aValue)
-
Methods inherited from class org.refcodes.serial.AbstractPayloadSection
getAlias, getPayload, setPayload, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.refcodes.serial.Section
fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom
-
Methods inherited from interface org.refcodes.serial.Section.SectionMixin
receiveFrom
-
Methods inherited from interface org.refcodes.serial.Transmission
transmitTo, transmitTo
-
Methods inherited from interface org.refcodes.serial.Transmission.TransmissionMixin
transmitTo
-
-
-
-
Constructor Detail
-
PropertiesSection
public PropertiesSection(org.refcodes.properties.Properties aPayload, TransmissionMetrics aTransmissionMetrics)
Constructs aPropertiesSection
with the givenProperties
payload being encoded with the givenCharset
. The properties from the payload are copied into thePropertiesSection
. The configuration attributes are taken from theTransmissionMetrics
configuration object, though only those attributes are supported which are also supported by the other constructors!- Parameters:
aPayload
- The payload to be contained by theSection
.aTransmissionMetrics
- TheTransmissionMetrics
to be used for configuring this instance.
-
PropertiesSection
public PropertiesSection(String aAlias, org.refcodes.properties.Properties aPayload, TransmissionMetrics aTransmissionMetrics)
Constructs aPropertiesSection
with the givenProperties
payload being encoded with the givenCharset
. The properties from the payload are copied into thePropertiesSection
. The configuration attributes are taken from theTransmissionMetrics
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 theSection
.aTransmissionMetrics
- TheTransmissionMetrics
to be used for configuring this instance.
-
PropertiesSection
public PropertiesSection()
Constructs an emptyPropertiesSection
using UTF-8 encoding for the payload.
-
PropertiesSection
public PropertiesSection(org.refcodes.properties.Properties aPayload)
Constructs aPropertiesSection
with the givenProperties
payload being UTF-8 encoded. The properties from the payload are copied into thePropertiesSection
.- Parameters:
aPayload
- The payload to be contained by theSection
.
-
PropertiesSection
public PropertiesSection(Charset aCharset)
Constructs aPropertiesSection
with a payload expected to be encoded with the givenCharset
.
-
PropertiesSection
public PropertiesSection(org.refcodes.properties.Properties aPayload, Charset aCharset)
Constructs aPropertiesSection
with the givenProperties
payload being encoded with the givenCharset
. The properties from the payload are copied into thePropertiesSection
.
-
PropertiesSection
public PropertiesSection(String aAlias)
Constructs an emptyPropertiesSection
using UTF-8 encoding for the payload.- Parameters:
aAlias
- The alias which identifies the content of this segment.
-
PropertiesSection
public PropertiesSection(String aAlias, org.refcodes.properties.Properties aPayload)
Constructs aPropertiesSection
with the givenProperties
payload being UTF-8 encoded. The properties from the payload are copied into thePropertiesSection
.- Parameters:
aAlias
- The alias which identifies the content of this segment.aPayload
- The payload to be contained by theSection
.
-
PropertiesSection
public PropertiesSection(String aAlias, Charset aCharset)
Constructs aPropertiesSection
with a payload expected to be encoded with the givenCharset
.
-
PropertiesSection
public PropertiesSection(String aAlias, org.refcodes.properties.Properties aPayload, Charset aCharset)
Constructs aPropertiesSection
with the givenProperties
payload being encoded with the givenCharset
. The properties from the payload are copied into thePropertiesSection
.
-
-
Method Detail
-
toSequence
public Sequence toSequence()
Provides theSequence
representation of thisTransmission
. In case of nestedTransmission
instances, allSequence
representations from all sub-segments are accumulated to the result as well. Caution, the Transmission (or its nestedTransmission
instances) may be backed by the returnedSequence
.- Specified by:
toSequence
in interfaceTransmission
- 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 givenSequence
data.- Specified by:
fromTransmission
in interfaceSection
- Parameters:
aSequence
- TheSequence
data from which to (re-)initialize this instance.aOffset
- The offset where to start processing the providedSequence
.aLength
- The length of data assigned by theSequence
.- Throws:
TransmissionException
- thrown in case a givenSequence
cannot be processed.
-
getLength
public int getLength()
Determines the overall length of thisTransmission
. In case of nestedTransmission
instances, all length values from all sub-segments are accumulated to the result as well.- Specified by:
getLength
in interfaceorg.refcodes.mixin.LengthAccessor
- Specified by:
getLength
in interfaceTransmission
- Returns:
- The (overall) length of the
Transmission
(including any sub-segments).
-
toSchema
public Schema toSchema()
Retrieves theSchema
representing theTransmission
. Retrieving aSchema
is useful when analyzing and debugging data structures such as aAllocSectionDecoratorSegment
instance to help document, learn and verify on the structure (as well as the content) of that veryAllocSectionDecoratorSegment
.- Specified by:
toSchema
in interfaceTransmission
- Returns:
- The
Schema
representation of the implementing type for debugging and verification (or documentation) purposes.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractPayloadSection<org.refcodes.properties.Properties>
-
equals
public boolean equals(Object obj)
- Overrides:
equals
in classAbstractPayloadSection<org.refcodes.properties.Properties>
-
withPayload
public PropertiesSection withPayload(org.refcodes.properties.Properties aValue)
- Specified by:
withPayload
in interfaceorg.refcodes.mixin.PayloadAccessor.PayloadBuilder<org.refcodes.properties.Properties,PayloadTransmission<org.refcodes.properties.Properties>>
-
toSimpleTypeMap
public org.refcodes.struct.SimpleTypeMap toSimpleTypeMap()
Returns theSimpleTypeMap
representation of thisTransmission
. In case this Transmission hasTransmission
children, then the children are queried as well and contained in the resultingSimpleTypeMap
. The aliases of the accordingTransmission
instances represent the resulting path to aTransmission
's final simple type.- Specified by:
toSimpleTypeMap
in interfaceTransmission
- Overrides:
toSimpleTypeMap
in classAbstractPayloadSection<org.refcodes.properties.Properties>
- Returns:
- The
SimpleTypeMap
representing thisTransmission
and (if any) its children, with the according aliases forming the paths to theTransmission
's values.
-
-