com.threerings.jpkg.ant.dpkg
Class Package

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.jpkg.ant.dpkg.Package
All Implemented Interfaces:
Field, ReferenceField, RequiresValidation, Cloneable

public class Package
extends BaseField

The <dpkg> task <package> field. Holds all information needed to generate a given package.


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
Package()
           
 
Method Summary
 void addDependencies(Dependencies dependencies)
          Ant adder field: Set the list of package dependencies.
 void addInfo(Info info)
          Ant adder field: Set the package meta information.
 void addPermissions(Permissions permissions)
          Ant adder field: Set the list of path permissions.
 void addScripts(Scripts scripts)
          Ant adder field: Set the list of maintainer scripts.
 PackageInfo createPackageInfo(String distribution, String prefix)
          Returns the user data converted into a PackageInfo object.
 File getDestroot()
          Returns the destroot to use for this package.
 String getFieldName()
          Returns the unique name of this Field.
 String getFilename()
          Returns the filename to use for this package.
 void setDestroot(String value)
          Ant setter field: destroot.
 void setFilename(String value)
          Ant setter field: filename.
protected  void validateField()
          Give each subclass a chance to do field specific validation.
 
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

Package

public Package()
Method Detail

getFieldName

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


addInfo

public void addInfo(Info info)
Ant adder field: Set the package meta information.


addScripts

public void addScripts(Scripts scripts)
Ant adder field: Set the list of maintainer scripts.


addPermissions

public void addPermissions(Permissions permissions)
Ant adder field: Set the list of path permissions.


addDependencies

public void addDependencies(Dependencies dependencies)
Ant adder field: Set the list of package dependencies.


setDestroot

public void setDestroot(String value)
Ant setter field: destroot. The directory where the root of the package starts.


setFilename

public void setFilename(String value)
Ant setter field: filename. Optionally set the filename of the package output.


createPackageInfo

public PackageInfo createPackageInfo(String distribution,
                                     String prefix)
Returns the user data converted into a PackageInfo object. Cannot be called before validate().


getDestroot

public File getDestroot()
Returns the destroot to use for this package. Cannot be called before validate().


getFilename

public String getFilename()
Returns the filename to use for this package. 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.