net.sf.okapi.common.resource

Class InlineAnnotation

java.lang.Object

net.sf.okapi.common.resource.InlineAnnotation

All Implemented Interfaces:

Cloneable, IAnnotation, IPersistentAnnotation

Direct Known Subclasses:

GenericAnnotation, GenericAnnotations

public class InlineAnnotation
extends Object
implements IPersistentAnnotation

Base implementation of an annotation that can be used on inline codes. Inline annotations must have a toString() and fromString(String) methods to write and read themselves to and from a string.

This basic annotation has only a string data. Its usage depends of the type of the annotation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSNAME_SEPARATOR
protected String	data

Constructor Summary

Constructors

Constructor and Description
InlineAnnotation() Creates an empty annotation object.
InlineAnnotation(String data) Creates a new annotation object with some initial data.

Method Summary

Modifier and Type	Method and Description
InlineAnnotation	clone() Clones this annotation.
static InlineAnnotation	createFromString(String storage) Creates a new InlineAnnotation object from a storage string.
void	fromString(String storage) Initializes this annotation from a storage string originally obtained from toString().
String	getData() Gets the data for this annotation.
void	setData(String data) Sets the data for this annotation.
String	toString() Gets a storage string representation of the whole annotation that can be used for serialization.

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME_SEPARATOR

public static final String CLASSNAME_SEPARATOR

See Also:

Constant Field Values

data

protected String data

Constructor Detail

InlineAnnotation

public InlineAnnotation()

Creates an empty annotation object.

InlineAnnotation

public InlineAnnotation(String data)

Creates a new annotation object with some initial data.

Parameters:

data - The data to set.

Method Detail

createFromString

public static InlineAnnotation createFromString(String storage)

Creates a new InlineAnnotation object from a storage string.

Parameters:

storage - the serialized representation of the object.

Returns:

a new InlineAnnotation object.

clone

public InlineAnnotation clone()

Clones this annotation.

Specified by:

clone in interface IPersistentAnnotation

Overrides:

clone in class Object

Returns:

A new InlineAnnotation object that is a copy of this one.

toString

public String toString()

Gets a storage string representation of the whole annotation that can be used for serialization.

Specified by:

toString in interface IAnnotation

Overrides:

toString in class Object

Returns:

The storage string representation of this annotation.

fromString

public void fromString(String storage)

Initializes this annotation from a storage string originally obtained from toString().

Specified by:

fromString in interface IPersistentAnnotation

Parameters:

storage - The storage string to use for the initialization.

getData

public String getData()

Gets the data for this annotation.

Returns:

The data of this annotation.

setData

public void setData(String data)

Sets the data for this annotation.

Parameters:

data - The data to set.