com.saperion.annotation

Class AbstractAnnotation

java.lang.Object

com.saperion.annotation.AbstractAnnotation

Direct Known Subclasses:

Arrow, Highlight, Text

public abstract class AbstractAnnotation
extends Object

Abstract annotation class containing common methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractAnnotation.AnnotationProperty Properties of annotations.
static class	AbstractAnnotation.AnnotationType Available annotation types.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAnnotation(AbstractAnnotation.AnnotationType annotationType, Map<AbstractAnnotation.AnnotationProperty,String> properties, Set<AbstractAnnotation.AnnotationProperty> requiredProperties) Creates a new AbstractAnnotation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getPage() Gets the page.
Map<AbstractAnnotation.AnnotationProperty,String>	getProperties() Gets the properties.
String	getProperty(AbstractAnnotation.AnnotationProperty property) Gets the property.
AbstractAnnotation.AnnotationType	getType() Gets the type.
int	hashCode()
boolean	isEdit() Checks if annotation can be edited.
void	setProperty(AbstractAnnotation.AnnotationProperty property, String value) Sets the property.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractAnnotation

protected AbstractAnnotation(AbstractAnnotation.AnnotationType annotationType,
                             Map<AbstractAnnotation.AnnotationProperty,String> properties,
                             Set<AbstractAnnotation.AnnotationProperty> requiredProperties)

Creates a new AbstractAnnotation.

Parameters:

annotationType - type

properties - properties of the annotation

requiredProperties - required properties for the type

Method Detail

getType

public AbstractAnnotation.AnnotationType getType()

Gets the type.

Returns:

the type

getPage

public int getPage()

Gets the page.

Returns:

the page

isEdit

public boolean isEdit()

Checks if annotation can be edited.

Returns:

true, the annotation can be edited

getProperties

public Map<AbstractAnnotation.AnnotationProperty,String> getProperties()

Gets the properties.

Returns:

the properties

getProperty

public String getProperty(AbstractAnnotation.AnnotationProperty property)

Gets the property.

Parameters:

property - the property

Returns:

the value of the property

setProperty

public void setProperty(AbstractAnnotation.AnnotationProperty property,
                        String value)

Sets the property.

Parameters:

property - the property

value - the value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()