SmartFrog 3.10.000

org.smartfrog.sfcore.parser
Interface Phases

All Superinterfaces:
ComponentDescription, Copying, PrettyPrinting, ReferenceResolver, ReferenceResolverHelper
All Known Subinterfaces:
CSFComponentDescription, SFComponentDescription
All Known Implementing Classes:
CSFComponentDescriptionImpl, SFComponentDescriptionImpl

public interface Phases
extends ComponentDescription

Defines the Phases interface. Objects that implement this interface are created by the parser. The phases may then be invoked and the finally the resultant Phases instance may be converted to a simple class implementing only ComponentDescritpion for handing to the SmartFrog deployment engine.


Method Summary
 ComponentDescription sfAsComponentDescription()
          Convert the Phases (resulting from applying the phases) to a ComponentDescription ready for the SmartFrog deployment engine.
 java.util.Vector sfGetPhases()
          Return the phases required to be evaluated.
 Phases sfResolvePhase(java.lang.String phase)
          Evaluate the phase given in the parameter.
 Phases sfResolvePhases()
          Evaluate all the phases required of the description implementing the interface.
 Phases sfResolvePhases(java.util.Vector phases)
          Evaluate the phases given in the parameter.
 
Methods inherited from interface org.smartfrog.sfcore.componentdescription.ComponentDescription
getEager, setContext, setEager, setParent, setPrimParent, sfAddAttribute, sfAttributeKeyFor, sfAttributes, sfCompleteName, sfContainsAttribute, sfContainsValue, sfContext, sfLog, sfParent, sfPrimParent, sfRemoveAttribute, sfReplaceAttribute, sfValues, toString, visit, visit, visit, visit, writeOn
 
Methods inherited from interface org.smartfrog.sfcore.common.PrettyPrinting
writeOn
 
Methods inherited from interface org.smartfrog.sfcore.common.Copying
clone, copy
 
Methods inherited from interface org.smartfrog.sfcore.reference.ReferenceResolver
sfResolve, sfResolve, sfResolveHere, sfResolveHere, sfResolveParent
 
Methods inherited from interface org.smartfrog.sfcore.reference.ReferenceResolverHelper
sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolveHere, sfResolveWithParser
 

Method Detail

sfResolvePhases

Phases sfResolvePhases()
                       throws SmartFrogException
Evaluate all the phases required of the description implementing the interface. The list of phases is defined as a default for the language used, or defined somehow as an attribute.

Returns:
An instance of Phases that is the result of applying all the defined phases
Throws:
SmartFrogException - error evaluating phases

sfResolvePhase

Phases sfResolvePhase(java.lang.String phase)
                      throws SmartFrogException
Evaluate the phase given in the parameter.

Parameters:
phase - the phase to apply
Returns:
An instance of Phases that is the result of applying the phase.
Throws:
SmartFrogException - error evaluating phases

sfResolvePhases

Phases sfResolvePhases(java.util.Vector phases)
                       throws SmartFrogException
Evaluate the phases given in the parameter.

Parameters:
phases - the phases to apply
Returns:
An instance of Phases that is the result of applying the phase.
Throws:
SmartFrogException - error evaluating phases

sfGetPhases

java.util.Vector sfGetPhases()
Return the phases required to be evaluated.

Returns:
the phases to apply

sfAsComponentDescription

ComponentDescription sfAsComponentDescription()
                                              throws SmartFrogCompilationException
Convert the Phases (resulting from applying the phases) to a ComponentDescription ready for the SmartFrog deployment engine.

Returns:
the convertion to a component description
Throws:
SmartFrogCompilationException - error converting phases to a componentdescription

SmartFrog CORE 3.10.000

(C) Copyright 1998-2006 Hewlett-Packard Development Company, LP