dk.dma.ais.sentence

Class CommentBlock

java.lang.Object

dk.dma.ais.sentence.CommentBlock

@NotThreadSafe
public class CommentBlock
extends Object

Class to hold a comment block

Constructor Summary

Constructors

Constructor and Description
CommentBlock()

Method Summary

Modifier and Type	Method and Description
void	addInt(String parameter, int value) Add integer value
void	addLine(String line) Add line containing comment block
void	addString(String parameter, String value) Add key value pair with string value
void	addTimestamp(Date timestamp) Add timestamp
boolean	contains(String parameter) Determine if parameter exists in comment block
String	encode() Encode comment block in 80 character lines
String	encode(int maxLen) Encode comment block in a number of lines
Integer	getInt(String parameter) Get integer value of parameter code
String	getLastGroupId() Get id of last group
Long	getLong(String parameter) Get long value of parameter code
int	getSize() Get number of entries in comment block
String	getString(String parameter) Get string value for parameter code
Long	getTimestamp() Get timestamp in tag
int	getTotalLines() Get total number of lines in last group
static boolean	hasCommentBlock(String line) Determine if a line contains comment block
boolean	isEmpty() Determine if comment block contains any key value pairs
boolean	isFinished() Determine if comment block is completed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentBlock

public CommentBlock()

Method Detail

addLine

public void addLine(String line)
             throws CommentBlockException

Add line containing comment block

Parameters:

line - the line

Throws:

CommentBlockException - the comment block exception

getSize

public int getSize()

Get number of entries in comment block

Returns:

size

getString

public String getString(String parameter)

Get string value for parameter code

Parameters:

parameter - the parameter

Returns:

string

addString

public void addString(String parameter,
                      String value)

Add key value pair with string value

Parameters:

parameter - the parameter

value - the value

addInt

public void addInt(String parameter,
                   int value)

Add integer value

Parameters:

parameter - the parameter

value - the value

addTimestamp

public void addTimestamp(Date timestamp)

Add timestamp

Parameters:

timestamp - the timestamp

getInt

public Integer getInt(String parameter)

Get integer value of parameter code

Parameters:

parameter - the parameter

Returns:

int

getLong

public Long getLong(String parameter)

Get long value of parameter code

Parameters:

parameter - the parameter

Returns:

long

getTimestamp

public Long getTimestamp()

Get timestamp in tag

Returns:

timestamp

contains

public boolean contains(String parameter)

Determine if parameter exists in comment block

Parameters:

parameter - the parameter

Returns:

boolean

hasCommentBlock

public static boolean hasCommentBlock(String line)

Determine if a line contains comment block

Parameters:

line - the line

Returns:

boolean

isFinished

public boolean isFinished()

Determine if comment block is completed. That is no unfinished groups.

Returns:

boolean

getLastGroupId

public String getLastGroupId()

Get id of last group

Returns:

last group id

getTotalLines

public int getTotalLines()

Get total number of lines in last group

Returns:

total lines

isEmpty

public boolean isEmpty()

Determine if comment block contains any key value pairs

Returns:

boolean

encode

public String encode()

Encode comment block in 80 character lines

Returns:

string

encode

public String encode(int maxLen)

Encode comment block in a number of lines

Parameters:

maxLen - Maximum line length

Returns:

string

toString

public String toString()

Overrides:

toString in class Object