org.xwiki.annotation.rest.model.jaxb
Class AnnotationStub

java.lang.Object
  org.xwiki.annotation.rest.model.jaxb.AnnotationStub

public class AnnotationStub
extends Object

Stores stub information about an annotation, such as the id, its target and its state, allowing it to be further requested from the annotation service for the extra details.

Java class for AnnotationStub complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="AnnotationStub">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="annotationId" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="target" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="state" type="{http://www.w3.org/2001/XMLSchema}anyType"/>
         <element name="fields" type="{http://www.xwiki.org}AnnotationField" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected String	annotationId
protected List<AnnotationField>	fields
protected Object	state
protected String	target

Constructor Summary

AnnotationStub()

Method Summary

String	getAnnotationId() Gets the value of the annotationId property.
List<AnnotationField>	getFields() Gets the value of the fields property.
Object	getState() Gets the value of the state property.
String	getTarget() Gets the value of the target property.
void	setAnnotationId(String value) Sets the value of the annotationId property.
void	setState(Object value) Sets the value of the state property.
void	setTarget(String value) Sets the value of the target property.
AnnotationStub	withAnnotationId(String value)
AnnotationStub	withFields(AnnotationField... values)
AnnotationStub	withFields(Collection<AnnotationField> values)
AnnotationStub	withState(Object value)
AnnotationStub	withTarget(String value)

Methods inherited from class java.lang.Object

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

Field Detail

annotationId

protected String annotationId

target

protected String target

state

protected Object state

fields

protected List<AnnotationField> fields

Constructor Detail

AnnotationStub

public AnnotationStub()

Method Detail

getAnnotationId

public String getAnnotationId()

Gets the value of the annotationId property.

Returns:

possible object is String

setAnnotationId

public void setAnnotationId(String value)

Sets the value of the annotationId property.

Parameters:

value - allowed object is String

getTarget

public String getTarget()

Gets the value of the target property.

Returns:

possible object is String

setTarget

public void setTarget(String value)

Sets the value of the target property.

Parameters:

value - allowed object is String

getState

public Object getState()

Gets the value of the state property.

Returns:

possible object is Object

setState

public void setState(Object value)

Sets the value of the state property.

Parameters:

value - allowed object is Object

getFields

public List<AnnotationField> getFields()

Gets the value of the fields property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the fields property.

For example, to add a new item, do as follows:

    getFields().add(newItem);
 

Objects of the following type(s) are allowed in the list AnnotationField

withAnnotationId

public AnnotationStub withAnnotationId(String value)

withTarget

public AnnotationStub withTarget(String value)

withState

public AnnotationStub withState(Object value)

withFields

public AnnotationStub withFields(AnnotationField... values)

withFields

public AnnotationStub withFields(Collection<AnnotationField> values)