net.sourceforge.javadpkg.field.impl

Class AbstractField

java.lang.Object

net.sourceforge.javadpkg.field.impl.AbstractField

All Implemented Interfaces:

Field

Direct Known Subclasses:

EmptyField, FieldImpl, NamelessField

public abstract class AbstractField
extends Object
implements Field

An abstract Field implementation.

Version:

1.0, 06.05.2016 by Gerrit Hohl

Author:

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

Constructor Summary

Constructors

Constructor and Description
AbstractField(boolean nameless, boolean empty) Creates a field.

Method Summary

Modifier and Type	Method and Description
protected String	formatValue(String value) Formats the specified value.
String	getFormattedValue() 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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.javadpkg.field.Field

getName, getValue

Constructor Detail

AbstractField

public AbstractField(boolean nameless,
                     boolean empty)

Creates a field.

Parameters:

nameless - The flag if the field is a nameless field.

empty - The flag if the field is an empty field.

Method Detail

formatValue

protected String formatValue(String value)

Formats the specified value.

All empty lines are filled with a ".".

Parameters:

value - The value.

Returns:

The formatted value.

isNameless

public boolean isNameless()

Description copied from interface: Field

Returns the flag if the field has no name.

An nameless field has no name, but a value.

Specified by:

isNameless in interface Field

Returns:

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

See Also:

Field.getName()

getFormattedValue

public String getFormattedValue()

Description copied from interface: Field

Returns the value.

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

Specified by:

getFormattedValue in interface Field

Returns:

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

See Also:

Field.isEmpty()

isEmpty

public boolean isEmpty()

Description copied from interface: Field

Returns the flag if the field is an empty field.

An empty field has no name and no value.

Specified by:

isEmpty in interface Field

Returns:

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

See Also:

Field.getName(), Field.getValue()