net.sf.okapi.common.resource

Interface IWithAnnotations

All Known Subinterfaces:

INameable, ITextUnit

All Known Implementing Classes:

BaseNameable, BaseReferenceable, Custom, Document, DocumentPart, Ending, EndSubfilter, MultiEvent, PipelineParameters, RawDocument, Segment, StartDocument, StartGroup, StartSubDocument, StartSubfilter, StorageList, TextContainer, TextPart, TextUnit

public interface IWithAnnotations

Method Summary

Modifier and Type	Method and Description
static void	copy(IWithAnnotations from, IWithAnnotations to) Copy all IWithAnnotations Unless destination already has the annotation. WARNING: Annotations are not cloned before copying.
<A extends IAnnotation> A	getAnnotation(Class<A> annotationType) Gets the annotation object for a given class for this resource.
Iterable<IAnnotation>	getAnnotations() Gets the iterable list of the annotations for this resource.
void	setAnnotation(IAnnotation annotation) Sets an annotation object for this resource.

Method Detail

copy

static void copy(IWithAnnotations from,
                 IWithAnnotations to)

Copy all IWithAnnotations Unless destination already has the annotation. WARNING: Annotations are not cloned before copying.

Parameters:

from - source of IWithAnnotations

to - destination of IWithAnnotations

getAnnotation

<A extends IAnnotation> A getAnnotation(Class<A> annotationType)

Gets the annotation object for a given class for this resource.

Type Parameters:

A - the type of the class.

Parameters:

annotationType - the class of the annotation object to retrieve.

Returns:

the annotation for the given class for this resource.

setAnnotation

void setAnnotation(IAnnotation annotation)

Sets an annotation object for this resource.

Parameters:

annotation - the annotation object to set.

getAnnotations

Iterable<IAnnotation> getAnnotations()

Gets the iterable list of the annotations for this resource.

Returns:

the iterable list of the annotations for this resource.