prantl.ant.eclipse
Class ClassPathEntryBinaryElement

java.lang.Object
  extended by prantl.ant.eclipse.ClassPathEntryElement
      extended by prantl.ant.eclipse.ClassPathEntryPathElement
          extended by prantl.ant.eclipse.ClassPathEntryBinaryElement
Direct Known Subclasses:
ClassPathEntryLibraryElement, ClassPathEntryVariableElement

public abstract class ClassPathEntryBinaryElement
extends ClassPathEntryPathElement

Describes an element under the element classpath referring to compiled classes. The attributes exported and source are optional.

Since:
Ant-Eclipse 1.0
Author:
Ferdinand Prantl <prantl@users.sourceforge.net>

Constructor Summary
ClassPathEntryBinaryElement()
          Creates a new instance of the element containing binary code.
 
Method Summary
 boolean getExported()
          Returns if the referred compiled byte-code is exported during the jar-file generation (not by default).
 java.lang.String getJavadoc()
          Returns a path with a generated javadoc documentation to the referred compiled byte-code or null if it has not been set, which means that the javadoc is not available.
 java.lang.String getSource()
          Returns a path with source code to the referred compiled byte-code or null if it has not been set, which means that the sources are not available.
 void setExported(boolean flag)
          Sets if the referred compiled byte-code is exported during the jar-file generation.
 void setJavadoc(java.lang.String value)
          Sets the path with a generated javadoc documentation to the referred compiled byte-code.
 void setSource(java.lang.String value)
          Sets the path with source code to the referred compiled byte-code.
 
Methods inherited from class prantl.ant.eclipse.ClassPathEntryPathElement
getPathRef, setPath, setPathRef, validate
 
Methods inherited from class prantl.ant.eclipse.ClassPathEntryElement
getPath
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClassPathEntryBinaryElement

public ClassPathEntryBinaryElement()
Creates a new instance of the element containing binary code.

Since:
Ant-Eclipse 1.0
Method Detail

getExported

public boolean getExported()
Returns if the referred compiled byte-code is exported during the jar-file generation (not by default).

Returns:
True if the referred compiled byte-code is exported during the jar-file generation.

setExported

public void setExported(boolean flag)
Sets if the referred compiled byte-code is exported during the jar-file generation.

Parameters:
flag - True if the referred compiled byte-code is exported during the jar-file generation.
Since:
Ant-Eclipse 1.0

getSource

public java.lang.String getSource()
Returns a path with source code to the referred compiled byte-code or null if it has not been set, which means that the sources are not available.

Returns:
A path with source code to the referred compiled byte-code or null if not having been set.

setSource

public void setSource(java.lang.String value)
Sets the path with source code to the referred compiled byte-code.

Parameters:
value - The path with source code to the referred compiled byte-code.
Since:
Ant-Eclipse 1.0

getJavadoc

public java.lang.String getJavadoc()
Returns a path with a generated javadoc documentation to the referred compiled byte-code or null if it has not been set, which means that the javadoc is not available. The path must be in formats accepted by Eclipse; either a path to a directory or a path to a zip-archive with correct prefixing:

Returns:
A path with javadoc to the referred compiled byte-code or null if not having been set.

setJavadoc

public void setJavadoc(java.lang.String value)
Sets the path with a generated javadoc documentation to the referred compiled byte-code. The path must be in formats accepted by Eclipse; either a path to a directory or a path to a zip-archive with correct prefixing:

Parameters:
value - The path with javadoc to the referred compiled byte-code.
Since:
Ant-Eclipse 1.0