org.jboss.deployers.spi.deployer.helpers
Class AbstractDeployer

java.lang.Object
  extended by org.jboss.deployers.spi.deployer.helpers.AbstractDeployer
All Implemented Interfaces:
Deployer, Ordered
Direct Known Subclasses:
AbstractAllInputDeployer, AbstractClassLoaderDeployer, AbstractParsingDeployer, AbstractRealDeployer

public abstract class AbstractDeployer
extends Object
implements Deployer

AbstractDeployer.

Version:
$Revision: 1.1 $
Author:
Adrian Brock

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.jboss.deployers.spi.Ordered
Ordered.OrderedComparator
 
Field Summary
protected  org.jboss.logging.Logger log
          The log
 
Fields inherited from interface org.jboss.deployers.spi.Ordered
COMPARATOR
 
Constructor Summary
AbstractDeployer()
           
 
Method Summary
 void addInput(Class<?> input)
          Add an input
 void addInput(String input)
          Add an input
 void addOutput(Class<?> output)
          Add an output
 void addOutput(String output)
          Add an output
 Class<?> getInput()
          Get the input for this deployer
 Set<String> getInputs()
          Get the input for this deployer
 Class<?> getOutput()
          Get the otput for this deployer
 Set<String> getOutputs()
          Get the outputs for this deployer
 int getRelativeOrder()
          Get the relative order
 DeploymentStage getStage()
          Get the deployment stage for this deployer
 boolean isAllInputs()
          Whether we want all inputs
 boolean isComponentsOnly()
          Whether we only want components
 boolean isParentFirst()
          Whether to process parents before children (default true)
 boolean isTopLevelOnly()
          Whether we only want the top level
 boolean isWantComponents()
          Whether we dont want components
 void setAllInputs(boolean allInputs)
          Set the allInputs.
 void setComponentsOnly(boolean componentsOnly)
          Set the components only.
 void setInput(Class<?> input)
          Set the input
 void setInputs(Class<?>... inputs)
          Set the inputs.
 void setInputs(Set<String> inputs)
          Set the inputs.
 void setInputs(String... inputs)
          Set the inputs.
 void setOutput(Class<?> output)
          Set the output
 void setOutputs(Class<?>... outputs)
          Set the outputs.
 void setOutputs(Set<String> outputs)
          Set the outputs.
 void setOutputs(String... outputs)
          Set the outputs.
 void setParentFirst(boolean parentFirst)
          Set the parentFirst.
 void setRelativeOrder(int relativeOrder)
          Set the relative order.
 void setStage(DeploymentStage stage)
          Set the stage.
 void setTopLevelOnly(boolean topLevelOnly)
          Set the top level only.
 void setWantComponents(boolean wantComponents)
          Set the want components.
 void undeploy(DeploymentUnit unit)
          Undeploy an deployment
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jboss.deployers.spi.deployer.Deployer
deploy
 

Field Detail

log

protected org.jboss.logging.Logger log
The log

Constructor Detail

AbstractDeployer

public AbstractDeployer()
Method Detail

getRelativeOrder

public int getRelativeOrder()
Description copied from interface: Ordered
Get the relative order

Specified by:
getRelativeOrder in interface Ordered
Returns:
the relative order

setRelativeOrder

public void setRelativeOrder(int relativeOrder)
Description copied from interface: Ordered
Set the relative order.

Specified by:
setRelativeOrder in interface Ordered
Parameters:
relativeOrder - the order

getStage

public DeploymentStage getStage()
Description copied from interface: Deployer
Get the deployment stage for this deployer

Specified by:
getStage in interface Deployer
Returns:
the stage

setStage

public void setStage(DeploymentStage stage)
Set the stage.

Parameters:
stage - the stage.
Throws:
IllegalArgumentException - for a null stage

isAllInputs

public boolean isAllInputs()
Description copied from interface: Deployer
Whether we want all inputs

Specified by:
isAllInputs in interface Deployer
Returns:
true for all inputs

setAllInputs

public void setAllInputs(boolean allInputs)
Set the allInputs.

Parameters:
allInputs - the allInputs.

isComponentsOnly

public boolean isComponentsOnly()
Description copied from interface: Deployer
Whether we only want components

Specified by:
isComponentsOnly in interface Deployer
Returns:
true for components only

setComponentsOnly

public void setComponentsOnly(boolean componentsOnly)
Set the components only.

Parameters:
componentsOnly - the componentsOnly.

isWantComponents

public boolean isWantComponents()
Description copied from interface: Deployer
Whether we dont want components

Specified by:
isWantComponents in interface Deployer
Returns:
true for no components

setWantComponents

public void setWantComponents(boolean wantComponents)
Set the want components.

Parameters:
wantComponents - the want components.

isTopLevelOnly

public boolean isTopLevelOnly()
Description copied from interface: Deployer
Whether we only want the top level

Specified by:
isTopLevelOnly in interface Deployer
Returns:
true for top level only

setTopLevelOnly

public void setTopLevelOnly(boolean topLevelOnly)
Set the top level only.

Parameters:
topLevelOnly - the top level only.

getInput

public Class<?> getInput()
Description copied from interface: Deployer
Get the input for this deployer

Specified by:
getInput in interface Deployer
Returns:
the input type

setInput

public void setInput(Class<?> input)
Set the input

Parameters:
input - the input

getOutput

public Class<?> getOutput()
Description copied from interface: Deployer
Get the otput for this deployer

Specified by:
getOutput in interface Deployer
Returns:
the output type

setOutput

public void setOutput(Class<?> output)
Set the output

Parameters:
output - the outputs

getInputs

public Set<String> getInputs()
Description copied from interface: Deployer
Get the input for this deployer

Specified by:
getInputs in interface Deployer
Returns:
the inputs

setInputs

public void setInputs(Set<String> inputs)
Set the inputs.

Parameters:
inputs - the inputs.

setInputs

public void setInputs(String... inputs)
Set the inputs.

Parameters:
inputs - the inputs.

setInputs

public void setInputs(Class<?>... inputs)
Set the inputs.

Parameters:
inputs - the inputs.

addInput

public void addInput(String input)
Add an input

Parameters:
input - the input

addInput

public void addInput(Class<?> input)
Add an input

Parameters:
input - the input

getOutputs

public Set<String> getOutputs()
Description copied from interface: Deployer
Get the outputs for this deployer

Specified by:
getOutputs in interface Deployer
Returns:
the outputs

setOutputs

public void setOutputs(Set<String> outputs)
Set the outputs.

Parameters:
outputs - the outputs.

setOutputs

public void setOutputs(String... outputs)
Set the outputs.

Parameters:
outputs - the outputs.

setOutputs

public void setOutputs(Class<?>... outputs)
Set the outputs.

Parameters:
outputs - the outputs.

addOutput

public void addOutput(String output)
Add an output

Parameters:
output - the output

addOutput

public void addOutput(Class<?> output)
Add an output

Parameters:
output - the output

isParentFirst

public boolean isParentFirst()
Description copied from interface: Deployer
Whether to process parents before children (default true)

Specified by:
isParentFirst in interface Deployer
Returns:
true to process parents first

setParentFirst

public void setParentFirst(boolean parentFirst)
Set the parentFirst.

Parameters:
parentFirst - the parentFirst.

undeploy

public void undeploy(DeploymentUnit unit)
Description copied from interface: Deployer
Undeploy an deployment

Specified by:
undeploy in interface Deployer
Parameters:
unit - the unit


Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.