com.threerings.jpkg.ant.dpkg.info
Class Description

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by com.threerings.antidote.field.BaseComponent
              extended by com.threerings.antidote.field.BaseField
                  extended by com.threerings.antidote.field.text.TextField
                      extended by com.threerings.jpkg.ant.dpkg.info.Description
All Implemented Interfaces:
Field, ReferenceField, RequiresValidation, Cloneable

public class Description
extends TextField

Stores the <info> <description> field, which is the package description.

See Also:
PackageDescription

Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
Description()
           
 
Method Summary
 void addBlank(Blank blank)
          Ant adder field: Add a blank line to this description.
 void addParagraph(Paragraph paragraph)
          Ant adder field: Add a word wrapped paragraph to this description.
 void addSummary(Summary summary)
          Ant adder field: Add the summary description.
 void addVerbatim(Verbatim verbatim)
          Ant adder field: Add a none word wrapped verbatim paragraph to this description.
 String getFieldName()
          Returns the unique name of this Field.
 PackageDescription getPackageDescription()
          Returns the user data converted into a PackageDescription.
protected  void validateField()
          Give each subclass a chance to do field specific validation.
 
Methods inherited from class com.threerings.antidote.field.text.TextField
addText, getText, scrubTextWhitespace, validateTextNotEmpty, validateTextWasSet
 
Methods inherited from class com.threerings.antidote.field.BaseField
execute, init, reconfigure, setRefid
 
Methods inherited from class com.threerings.antidote.field.BaseComponent
appendViolation, appendViolationList, getReferencedField, isReference, registerField, reportConflictingProperties, reportUnsetDependentFields, reportUnsetDependentProperties, reportUnsetField, setReference, validate, validateChildFields, validateChildFields, validateOptionalProperties, validateProperties, validateProperties
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.threerings.antidote.field.Field
getLocation
 

Constructor Detail

Description

public Description()
Method Detail

getFieldName

public String getFieldName()
Description copied from interface: Field
Returns the unique name of this Field.


addSummary

public void addSummary(Summary summary)
Ant adder field: Add the summary description.


addBlank

public void addBlank(Blank blank)
Ant adder field: Add a blank line to this description.


addParagraph

public void addParagraph(Paragraph paragraph)
Ant adder field: Add a word wrapped paragraph to this description.


addVerbatim

public void addVerbatim(Verbatim verbatim)
Ant adder field: Add a none word wrapped verbatim paragraph to this description.


getPackageDescription

public PackageDescription getPackageDescription()
Returns the user data converted into a PackageDescription. Cannot be called before validate().


validateField

protected void validateField()
Description copied from class: BaseComponent
Give each subclass a chance to do field specific validation.

Specified by:
validateField in class BaseComponent


Copyright © 2007-2008 Three Rings Design, Inc. All Rights Reserved. Released under a BSD license.