com.levigo.jadice.annotation.embedded
Class EmbeddedAnnotations

java.lang.Object
  com.levigo.jadice.annotation.embedded.EmbeddedAnnotations

public class EmbeddedAnnotations
extends Object

This class contains various utility methods for embedded annotations.

Constructor Summary

EmbeddedAnnotations()

Method Summary

static Collection<EmbeddedAnnotation>	get(Page page) Returns an unmodifiable list of all embedded annotations of given page.
static String	getText(EmbeddedAnnotation a)
static boolean	hasText(EmbeddedAnnotation a)
static boolean	isAnnotated(Document document) Returns whether the given document is annotated.
static boolean	isAnnotated(Page page) Returns whether the given page is annotated.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedAnnotations

public EmbeddedAnnotations()

Method Detail

get

public static Collection<EmbeddedAnnotation> get(Page page)

Returns an unmodifiable list of all embedded annotations of given page.

Parameters:

page - the page the embedded annotations should be retrieved from

Returns:

Collection containing all embedded annotations of the page

Throws:

IllegalArgumentException - if page is null

isAnnotated

public static boolean isAnnotated(Document document)

Returns whether the given document is annotated.

Parameters:

document - the document the annotation lookup should be done for

Returns:

true if at least one page of the document has annotations

Throws:

IllegalArgumentException - if document is null

isAnnotated

public static boolean isAnnotated(Page page)

Returns whether the given page is annotated.

Parameters:

page - the page the annotation lookup should be done for

Returns:

true if at least one annotation is contained in the page

Throws:

IllegalArgumentException - if page is null

hasText

public static boolean hasText(EmbeddedAnnotation a)

getText

public static String getText(EmbeddedAnnotation a)