Module cl.netswitch.iso

Package cl.netswitch.iso.vip8583

Class VipYamlWriter<M>

java.lang.Object

cl.netswitch.iso.vip8583.VipYamlWriter<M>

Type Parameters:

M - the type of the message.

All Implemented Interfaces:

VipWriter<M>

public class VipYamlWriter<M>
extends Object
implements VipWriter<M>

Converts a message of VIP fields to a YAML representation.

Constructor Summary

Constructors

Constructor	Description
VipYamlWriter()	Constructs a new VipYamlWriter instance.
VipYamlWriter(int capacity)	Constructs a new VipYamlWriter instance with capacity.

Method Summary

Modifier and Type	Method	Description
void	closeGroup(String name)	Marks the end of a group of fields or properties.
String	openGroup(String name)	Marks the beginning of group of fields or properties.
void	reset()	Reset this writer so it can be reused again.
String	toString()	Returns the YAML string built using this writer.
void	writeField(VipField<M,?> field, M message)	Writes a field and the value it contains in message.
void	writeProperty(VipField<?,?> field, String name, Object value, String comment)	Writes the name and value of a field property.
void	writeValue(VipField<?,?> field, Object value)	Writes the value of a field or field property.

Methods inherited from class java.lang.Object

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

Constructor Details

VipYamlWriter

public VipYamlWriter()

Constructs a new VipYamlWriter instance.

VipYamlWriter

public VipYamlWriter(int capacity)

Constructs a new VipYamlWriter instance with capacity.

Parameters:

capacity - the initial capacity of this writer.

Throws:

NegativeArraySizeException - if capacity is negative.

Method Details

toString

public String toString()

Returns the YAML string built using this writer.

Overrides:

toString in class Object

Returns:

the YAML string built using this writer.

openGroup

public String openGroup(String name)

Marks the beginning of group of fields or properties. The group must be closed later calling closeGroup with the returned group name, which may not be the same as the supplied argument.

Specified by:

openGroup in interface VipWriter<M>

Parameters:

name - the optional name of the group (can be null).

Returns:

the group name to use when closing the group.

See Also:

• closeGroup(String)

closeGroup

public void closeGroup(String name)

Marks the end of a group of fields or properties. The group must have been opened before calling openGroup using the same name.

Specified by:

closeGroup in interface VipWriter<M>

Parameters:

name - the optional name of the group (can be null).

See Also:

• openGroup(String)

writeField

public void writeField(VipField<M,?> field,
 M message)

Writes a field and the value it contains in message.

Specified by:

writeField in interface VipWriter<M>

Parameters:

field - the field to be written.

message - the message that contains the field value.

Throws:

NullPointerException - if an argument is null.

writeProperty

public void writeProperty(VipField<?,?> field,
 String name,
 Object value,
 String comment)

Writes the name and value of a field property.

Specified by:

writeProperty in interface VipWriter<M>

Parameters:

field - the field that contains the property.

name - the name of the property of the field.

value - the value of the field property (can be null).

comment - a description of the property (can be null).

Throws:

NullPointerException - if an argument is null.

writeValue

public void writeValue(VipField<?,?> field,
 Object value)

Writes the value of a field or field property.

Specified by:

writeValue in interface VipWriter<M>

Parameters:

field - the field that contains the value.

value - the value of the field or property (can be null).

Throws:

NullPointerException - if field is null.

reset

public void reset()

Reset this writer so it can be reused again.

Specified by:

reset in interface VipWriter<M>