com.threerings.jpkg.ant.dpkg.info
Class Description
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
com.threerings.antidote.field.BaseComponent
com.threerings.antidote.field.BaseField
com.threerings.antidote.field.text.TextField
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
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 interface com.threerings.antidote.field.Field |
getLocation |
Description
public Description()
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.