nl.lxtreme.ols.api.data.annotation
Interface Annotation<ANNOTATION_TYPE>

All Superinterfaces:
Comparable<Annotation<ANNOTATION_TYPE>>
All Known Subinterfaces:
DataAnnotation<ANNOTATION_TYPE>

public interface Annotation<ANNOTATION_TYPE>
extends Comparable<Annotation<ANNOTATION_TYPE>>

Denotes an annotation.


Method Summary
 ANNOTATION_TYPE getAnnotation()
          Returns the actual annotation.
 int getChannel()
          Returns the channel index of the channel to annotate.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getAnnotation

ANNOTATION_TYPE getAnnotation()
Returns the actual annotation.

The given annotation type is generic, meaning it can be of any type. One constraint that all annotation types must adhere is that they have a proper Object.toString() implementation.

Returns:
an annotation, never null.

getChannel

int getChannel()
Returns the channel index of the channel to annotate.

Returns:
a channel index, >= 0 && < 32.


Copyright © 2012 L'Xtreme IT consultancy. All Rights Reserved.