Module org.refcodes.serial

Package org.refcodes.serial

Class StringSegment.Builder

java.lang.Object

org.refcodes.serial.StringSegment.Builder

All Implemented Interfaces:

org.refcodes.mixin.AliasAccessor.AliasBuilder<StringSegment.Builder>, org.refcodes.mixin.EncodingAccessor.EncodingBuilder<Charset,StringSegment.Builder>, org.refcodes.mixin.ValueAccessor.ValueBuilder<String,StringSegment.Builder>, org.refcodes.numerical.EndianessAccessor.EndianessBuilder<StringSegment.Builder>, LengthWidthAccessor.LengthWidthBuilder<StringSegment.Builder>

Enclosing class:

StringSegment

public static final class StringSegment.Builder
extends Object
implements org.refcodes.mixin.AliasAccessor.AliasBuilder<StringSegment.Builder>, org.refcodes.mixin.ValueAccessor.ValueBuilder<String,StringSegment.Builder>, org.refcodes.mixin.EncodingAccessor.EncodingBuilder<Charset,StringSegment.Builder>, LengthWidthAccessor.LengthWidthBuilder<StringSegment.Builder>, org.refcodes.numerical.EndianessAccessor.EndianessBuilder<StringSegment.Builder>

Builder to build StringSegment instances.

Method Summary

Modifier and Type	Method	Description
StringSegment	build()	Builds the accordingly configured StringSegment instance.
StringSegment.Builder	withAlias(String aAlias)
StringSegment.Builder	withEncoding(Charset aEncoding)
StringSegment.Builder	withEndianess(org.refcodes.numerical.Endianess aEndianess)
StringSegment.Builder	withLengthWidth(int aLengthWidth)	Sets the length width (in bytes) for the length width (in bytes) property.
StringSegment.Builder	withValue(String aValue)

Methods inherited from class java.lang.Object

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

Method Details

withAlias

public StringSegment.Builder withAlias(String aAlias)

Specified by:

withAlias in interface org.refcodes.mixin.AliasAccessor.AliasBuilder<StringSegment.Builder>

withValue

public StringSegment.Builder withValue(String aValue)

Specified by:

withValue in interface org.refcodes.mixin.ValueAccessor.ValueBuilder<String,StringSegment.Builder>

withEncoding

public StringSegment.Builder withEncoding(Charset aEncoding)

Specified by:

withEncoding in interface org.refcodes.mixin.EncodingAccessor.EncodingBuilder<Charset,StringSegment.Builder>

withLengthWidth

public StringSegment.Builder withLengthWidth(int aLengthWidth)

Sets the length width (in bytes) for the length width (in bytes) property.

Specified by:

withLengthWidth in interface LengthWidthAccessor.LengthWidthBuilder<StringSegment.Builder>

Parameters:

aLengthWidth - The length width (in bytes) to be stored by the length width (in bytes) property.

Returns:

The builder for applying multiple build operations.

withEndianess

public StringSegment.Builder withEndianess(org.refcodes.numerical.Endianess aEndianess)

Specified by:

withEndianess in interface org.refcodes.numerical.EndianessAccessor.EndianessBuilder<StringSegment.Builder>

build

public StringSegment build()

Builds the accordingly configured StringSegment instance.

Returns:

The StringSegment being configured.