org.jboss.deployers.vfs.plugins.structure.explicit
Class DeclaredStructure

java.lang.Object
  extended by org.jboss.deployers.vfs.spi.structure.helpers.AbstractStructureDeployer
      extended by org.jboss.deployers.vfs.plugins.structure.AbstractVFSStructureDeployer
          extended by org.jboss.deployers.vfs.plugins.structure.explicit.DeclaredStructure
All Implemented Interfaces:
Ordered, StructureDeployer

public class DeclaredStructure
extends AbstractVFSStructureDeployer

A structural deployer that looks for a jboss-structure.xml descriptor as the defining structure.

Version:
$Revision: 1.1 $
Author:
Scott.Stark@jboss.org

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.jboss.deployers.spi.Ordered
Ordered.OrderedComparator
 
Field Summary
 
Fields inherited from class org.jboss.deployers.vfs.spi.structure.helpers.AbstractStructureDeployer
log
 
Fields inherited from interface org.jboss.deployers.spi.Ordered
COMPARATOR
 
Constructor Summary
DeclaredStructure()
          Set the relative order to 0 by default.
 
Method Summary
 boolean determineStructure(StructureContext structureContext)
          Determine the structure of a deployment
 
Methods inherited from class org.jboss.deployers.vfs.plugins.structure.AbstractVFSStructureDeployer
createAnnotationEnvironment, setExcluded, setFilter, setIncluded, setRecurseFilter
 
Methods inherited from class org.jboss.deployers.vfs.spi.structure.helpers.AbstractStructureDeployer
addAllChildren, addAllChildren, addCandidateAnnotation, addChildren, addChildren, addClassPath, applyContextInfo, applyMetadataPath, applyMetadataPaths, applyStructure, checkCandidateAnnotations, createContext, createContext, createContext, getCandidateAnnotations, getCandidateStructureVisitorFactory, getRelativeOrder, getRelativePath, getRelativePath, isLeaf, isSupportsCandidateAnnotations, setCandidateAnnotations, setCandidateStructureVisitorFactory, setContextInfoOrder, setRelativeOrder, setSupportsCandidateAnnotations
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DeclaredStructure

public DeclaredStructure()
Set the relative order to 0 by default.

Method Detail

determineStructure

public boolean determineStructure(StructureContext structureContext)
                           throws DeploymentException
Description copied from interface: StructureDeployer
Determine the structure of a deployment

Parameters:
structureContext - the structure context
Returns:
true when it recognised the context
Throws:
DeploymentException - for an error


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