biz.c24.io.api.data
Class Documentation

java.lang.Object
  extended by biz.c24.io.api.data.AnnotationItem
      extended by biz.c24.io.api.data.Documentation
All Implemented Interfaces:
Serializable

public class Documentation
extends AnnotationItem

An annotation designed for human consumption.

Warning: Serialized objects of this class or of a deployed class which is derived from it may not be compatible with future releases of C24 Integreation Objects. The current serialization support is appropriate for short term storage or RMI between applications running the same version of C24 Integreation Objects.

See Also:
Serialized Form

Constructor Summary
Documentation(String text, String source, String language)
          Constructs a new instance with specified values.
 
Method Summary
 String getLanguage()
          Returns the language the documentation text is expressed in.
 
Methods inherited from class biz.c24.io.api.data.AnnotationItem
getSource, getText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Documentation

public Documentation(String text,
                     String source,
                     String language)
Constructs a new instance with specified values. Either text or source argument can be null but not at the same time.

Parameters:
text - The textual content.
source - The source.
language - The language the documentation is expressed in.
Throws:
NullPointerException - if text and source are both null.
Method Detail

getLanguage

public String getLanguage()
Returns the language the documentation text is expressed in.

Returns:
The language.


C24 Technologies © 2002-2012: All Rights Reserved.