com.asakusafw.operator.model

Class OperatorDescription.Document

java.lang.Object

com.asakusafw.operator.model.OperatorDescription.Document

Direct Known Subclasses:

OperatorDescription.ExternalDocument, OperatorDescription.ReferenceDocument, OperatorDescription.TextDocument

Enclosing class:

OperatorDescription

public abstract static class OperatorDescription.Document
extends Object

Represents document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperatorDescription.Document.Kind Represents document kind.

Constructor Summary

Constructors

Constructor and Description
Document()

Method Summary

Modifier and Type	Method and Description
static OperatorDescription.ExternalDocument	external(Element element) Creates a new instance.
abstract OperatorDescription.Document.Kind	getKind() Returns the kind of this document.
static OperatorDescription.ReferenceDocument	reference(OperatorDescription.Reference reference) Creates a new instance.
static OperatorDescription.TextDocument	text(String text) Creates a new instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document()

Method Detail

text

public static OperatorDescription.TextDocument text(String text)

Creates a new instance.

Parameters:

text - text of this document

Returns:

the created instance

Throws:

IllegalArgumentException - if some parameters were null

reference

public static OperatorDescription.ReferenceDocument reference(OperatorDescription.Reference reference)

Creates a new instance.

Parameters:

reference - reference description

Returns:

the created instance

Throws:

IllegalArgumentException - if some parameters were null

external

public static OperatorDescription.ExternalDocument external(Element element)

Creates a new instance.

Parameters:

element - the target element

Returns:

the created instance

Throws:

IllegalArgumentException - if some parameters were null

getKind

public abstract OperatorDescription.Document.Kind getKind()

Returns the kind of this document.

Returns:

the kind