net.sourceforge.javadpkg.field

Interface Field

All Known Implementing Classes:

AbstractField, EmptyField, FieldImpl, NamelessField

public interface Field

A field having a name and a value.

The name and value of empty fields are null. These fields represents empty lines in the source / target.

The value can contain newlines.

Version:

1.0, 03.01.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
String	getFormattedValue() Returns the value.
String	getName() Returns the name.
String	getValue() Returns the value.
boolean	isEmpty() Returns the flag if the field is an empty field.
boolean	isNameless() Returns the flag if the field has no name.

Method Detail

getName

String getName()

Returns the name.

Returns:

The name or null, if the field is an empty field or a nameless field.

See Also:

isEmpty(), isNameless()

isNameless

boolean isNameless()

Returns the flag if the field has no name.

An nameless field has no name, but a value.

Returns:

The flag: true, if the field has no name, false otherwise.

See Also:

getName()

getValue

String getValue()

Returns the value.

The value can contain newlines.

Returns:

The value or null, if the field is an empty field.

See Also:

isEmpty()

getFormattedValue

String getFormattedValue()

Returns the value.

The value can contain newlines. All "." lines are replaced by empty lines.

Returns:

The value or null, if the field is an empty field.

See Also:

isEmpty()

isEmpty

boolean isEmpty()

Returns the flag if the field is an empty field.

An empty field has no name and no value.

Returns:

The flag: true, if the field is an empty field.

See Also:

getName(), getValue()