org.objectweb.jonas_ws.wsgen
Interface GenerationContext

All Known Implementing Classes:
GenerationContextImpl

public interface GenerationContext

The interface GenerationContext contains properties used along the Generation process.

Author:
Guillaume Sauthier

Field Summary
static java.lang.String CLASSPATH
          classpath property name
static java.lang.String FILENAME
          filename property name
static java.lang.String GEN_DIR
          generation dir property name
static java.lang.String JAVA_HOME
          $JAVA_HOME/bin property name
 
Method Summary
 boolean containsProperty(java.lang.String name)
          Returns true if the GenerationContext contains a property with the specified name.
 java.lang.String getClasspath()
          Helper method returning the classpath.
 java.lang.String getFilename()
          Helper method returning the processed filename.
 java.lang.String getJavaHomeBin()
          Helper method returning the $JAVA_HOME/bin value.
 java.lang.Object getProperty(java.lang.String name)
          Get an property, return the property value or null if the property isn't set.
 java.lang.Object getProperty(java.lang.String name, java.lang.Object defolt)
          Get an property, return the property value or default if the property isn't set.
 java.util.Iterator getPropertyNames()
          Returns an Iterator view of the names of the properties in this GenerationContext
 void removeProperty(java.lang.String name)
          Removes a property (name-value pair) from the GenerationContext
 void setProperty(java.lang.String name, java.lang.Object value)
          Set a property for generation.
 

Field Detail

FILENAME

public static final java.lang.String FILENAME
filename property name

See Also:
Constant Field Values

CLASSPATH

public static final java.lang.String CLASSPATH
classpath property name

See Also:
Constant Field Values

GEN_DIR

public static final java.lang.String GEN_DIR
generation dir property name

See Also:
Constant Field Values

JAVA_HOME

public static final java.lang.String JAVA_HOME
$JAVA_HOME/bin property name

See Also:
Constant Field Values
Method Detail

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
Set a property for generation.

Parameters:
name - property name
value - property value

getProperty

public java.lang.Object getProperty(java.lang.String name,
                                    java.lang.Object defolt)
Get an property, return the property value or default if the property isn't set.

Parameters:
name - property name
defolt - property value
Returns:
the property value or default if the property isn't set.

getProperty

public java.lang.Object getProperty(java.lang.String name)
Get an property, return the property value or null if the property isn't set.

Parameters:
name - property name
Returns:
the property value or null if the property isn't set.

removeProperty

public void removeProperty(java.lang.String name)
Removes a property (name-value pair) from the GenerationContext

Parameters:
name - Name of the property to be removed

containsProperty

public boolean containsProperty(java.lang.String name)
Returns true if the GenerationContext contains a property with the specified name.

Parameters:
name - Name of the property whose presense is to be tested
Returns:
Returns true if the GenerationContext contains the property; otherwise false

getPropertyNames

public java.util.Iterator getPropertyNames()
Returns an Iterator view of the names of the properties in this GenerationContext

Returns:
Iterator for the property names

getFilename

public java.lang.String getFilename()
Helper method returning the processed filename.

Returns:
the processed filename.

getClasspath

public java.lang.String getClasspath()
Helper method returning the classpath.

Returns:
the classpath.

getJavaHomeBin

public java.lang.String getJavaHomeBin()
Helper method returning the $JAVA_HOME/bin value.

Returns:
the $JAVA_HOME/bin value.