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

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

public class AnnotationStub
extends java.lang.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="field" type="{http://www.xwiki.org}AnnotationField" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  java.lang.String annotationId
           
protected  java.util.List<AnnotationField> fields
           
protected  java.lang.Object state
           
protected  java.lang.String target
           
 
Constructor Summary
AnnotationStub()
           
 
Method Summary
 java.lang.String getAnnotationId()
          Gets the value of the annotationId property.
 java.util.List<AnnotationField> getFields()
          Gets the value of the fields property.
 java.lang.Object getState()
          Gets the value of the state property.
 java.lang.String getTarget()
          Gets the value of the target property.
 void setAnnotationId(java.lang.String value)
          Sets the value of the annotationId property.
 void setState(java.lang.Object value)
          Sets the value of the state property.
 void setTarget(java.lang.String value)
          Sets the value of the target property.
 AnnotationStub withAnnotationId(java.lang.String value)
           
 AnnotationStub withFields(AnnotationField... values)
           
 AnnotationStub withFields(java.util.Collection<AnnotationField> values)
           
 AnnotationStub withState(java.lang.Object value)
           
 AnnotationStub withTarget(java.lang.String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

annotationId

protected java.lang.String annotationId

target

protected java.lang.String target

state

protected java.lang.Object state

fields

protected java.util.List<AnnotationField> fields
Constructor Detail

AnnotationStub

public AnnotationStub()
Method Detail

getAnnotationId

public java.lang.String getAnnotationId()
Gets the value of the annotationId property.

Returns:
possible object is String

setAnnotationId

public void setAnnotationId(java.lang.String value)
Sets the value of the annotationId property.

Parameters:
value - allowed object is String

getTarget

public java.lang.String getTarget()
Gets the value of the target property.

Returns:
possible object is String

setTarget

public void setTarget(java.lang.String value)
Sets the value of the target property.

Parameters:
value - allowed object is String

getState

public java.lang.Object getState()
Gets the value of the state property.

Returns:
possible object is Object

setState

public void setState(java.lang.Object value)
Sets the value of the state property.

Parameters:
value - allowed object is Object

getFields

public java.util.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(java.lang.String value)

withTarget

public AnnotationStub withTarget(java.lang.String value)

withState

public AnnotationStub withState(java.lang.Object value)

withFields

public AnnotationStub withFields(AnnotationField... values)

withFields

public AnnotationStub withFields(java.util.Collection<AnnotationField> values)


Copyright © 2004-2011 XWiki. All Rights Reserved.