AntXMLContext (Apache Ant API)

Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.tools.ant.helper
Class AntXMLContext

    java.lang.Object
      org.apache.tools.ant.helper.AntXMLContext

    public class AntXMLContext

extends java.lang.Object

Context information for the ant processing.

Constructor Summary
`AntXMLContext(Project project)` constructor

Method Summary
`void` | `addTarget(Target target)` add a new target
`void` | `configureId(java.lang.Object element, org.xml.sax.Attributes attr)` Scans an attribute list for the `id` attribute and stores a reference to the target object in the project if an id is found.
`RuntimeConfigurable` | `currentWrapper()` get the current runtime configurable wrapper can return null
`void` | `endPrefixMapping(java.lang.String prefix)` End of prefix to uri mapping.
`java.io.File` | `getBuildFile()` find out the build file
`java.io.File` | `getBuildFileParent()` find out the parent build file of this build file
`java.lang.String` | `getCurrentProjectName()` find out the current project name
`Target` | `getCurrentTarget()` get the current target
`java.util.Map` | `getCurrentTargets()` Get the targets in the current source file.
`Target` | `getImplicitTarget()` get the implicit target
`org.xml.sax.Locator` | `getLocator()` access the locator
`java.lang.String` | `getPrefixMapping(java.lang.String prefix)` prefix to namespace uri mapping
`Project` | `getProject()` find out the project to which this antxml context belongs
`java.util.Vector` | `getTargets()` access the vector of targets
`java.util.Vector` | `getWrapperStack()` access the stack of wrappers
`boolean` | `isIgnoringProjectTag()` tells whether the project tag is being ignored
`RuntimeConfigurable` | `parentWrapper()` get the runtime configurable wrapper of the parent project can return null
`void` | `popWrapper()` remove a runtime configurable wrapper from the stack
`void` | `pushWrapper(RuntimeConfigurable wrapper)` add a runtime configurable wrapper to the internal stack
`void` | `setBuildFile(java.io.File buildFile)` sets the build file to which the XML context belongs
`void` | `setCurrentProjectName(java.lang.String name)` set the name of the current project
`void` | `setCurrentTarget(Target target)` sets the current target
`void` | `setCurrentTargets(java.util.Map currentTargets)` Set the map of the targets in the current source file.
`void` | `setIgnoreProjectTag(boolean flag)` sets the flag to ignore the project tag
`void` | `setImplicitTarget(Target target)` sets the implicit target
`void` | `setLocator(org.xml.sax.Locator locator)` sets the locator
`void` | `startPrefixMapping(java.lang.String prefix, java.lang.String uri)` Called during parsing, stores the prefix to uri mapping.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### AntXMLContext

    public AntXMLContext(Project project)

  constructor

  Parameters:
    `project` - the project to which this antxml context belongs to

Method Detail

### setBuildFile

    public void setBuildFile(java.io.File buildFile)

  sets the build file to which the XML context belongs

  Parameters:
    `buildFile` - ant build file

### getBuildFile

    public java.io.File getBuildFile()

  find out the build file

  Returns:
    the build file to which the xml context belongs

### getBuildFileParent

    public java.io.File getBuildFileParent()

  find out the parent build file of this build file

  Returns:
    the parent build file of this build file

### getProject

    public Project getProject()

  find out the project to which this antxml context belongs

  Returns:
    project

### getCurrentProjectName

    public java.lang.String getCurrentProjectName()

  find out the current project name

  Returns:
    current project name

### setCurrentProjectName

    public void setCurrentProjectName(java.lang.String name)

  set the name of the current project

  Parameters:
    `name` - name of the current project

### currentWrapper

    public RuntimeConfigurable currentWrapper()

  get the current runtime configurable wrapper can return null

  Returns:
    runtime configurable wrapper

### parentWrapper

    public RuntimeConfigurable parentWrapper()

  get the runtime configurable wrapper of the parent project can return null

  Returns:
    runtime configurable wrapper of the parent project

### pushWrapper

    public void pushWrapper(RuntimeConfigurable wrapper)

  add a runtime configurable wrapper to the internal stack

  Parameters:
    `wrapper` - runtime configurable wrapper

### popWrapper

    public void popWrapper()

  remove a runtime configurable wrapper from the stack

### getWrapperStack

    public java.util.Vector getWrapperStack()

  access the stack of wrappers

  Returns:
    the stack of wrappers

### addTarget

    public void addTarget(Target target)

  add a new target

  Parameters:
    `target` - target to add

### getCurrentTarget

    public Target getCurrentTarget()

  get the current target

  Returns:
    current target

### getImplicitTarget

    public Target getImplicitTarget()

  get the implicit target

  Returns:
    implicit target

### setCurrentTarget

    public void setCurrentTarget(Target target)

  sets the current target

  Parameters:
    `target` - current target

### setImplicitTarget

    public void setImplicitTarget(Target target)

  sets the implicit target

  Parameters:
    `target` - the implicit target

### getTargets

    public java.util.Vector getTargets()

  access the vector of targets

  Returns:
    vector of targets

### configureId

    public void configureId(java.lang.Object element,
                            org.xml.sax.Attributes attr)

  Scans an attribute list for the `id` attribute and stores a reference to the target object in the project if an id is found.

  This method was moved out of the configure method to allow it to be executed at parse time.

  Parameters:
    `element` - the current element
    `attr` - attributes of the current element

### getLocator

    public org.xml.sax.Locator getLocator()

  access the locator

  Returns:
    locator

### setLocator

    public void setLocator(org.xml.sax.Locator locator)

  sets the locator

  Parameters:
    `locator` - locator

### isIgnoringProjectTag

    public boolean isIgnoringProjectTag()

  tells whether the project tag is being ignored

  Returns:
    whether the project tag is being ignored

### setIgnoreProjectTag

    public void setIgnoreProjectTag(boolean flag)

  sets the flag to ignore the project tag

  Parameters:
    `flag` - to ignore the project tag

### startPrefixMapping

    public void startPrefixMapping(java.lang.String prefix,
                                   java.lang.String uri)

  Called during parsing, stores the prefix to uri mapping.

  Parameters:
    `prefix` - a namespace prefix
    `uri` - a namespace uri

### endPrefixMapping

    public void endPrefixMapping(java.lang.String prefix)

  End of prefix to uri mapping.

  Parameters:
    `prefix` - the namespace prefix

### getPrefixMapping

    public java.lang.String getPrefixMapping(java.lang.String prefix)

  prefix to namespace uri mapping

  Parameters:
    `prefix` - the prefix to map
  Returns:
    the uri for this prefix, null if not present

### getCurrentTargets

    public java.util.Map getCurrentTargets()

  Get the targets in the current source file.

  Returns:
    the current targets.

### setCurrentTargets

    public void setCurrentTargets(java.util.Map currentTargets)

  Set the map of the targets in the current source file.

  Parameters:
    `currentTargets` - a map of targets.

Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD