|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.deployers.vfs.spi.structure.helpers.AbstractStructureDeployer
public abstract class AbstractStructureDeployer
AbstractStructureDeployer.
We don't care about the order by default.
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 | |
---|---|
AbstractStructureDeployer()
|
Method Summary | |
---|---|
protected void |
addAllChildren(StructureContext context)
Add all children as candidates |
protected void |
addAllChildren(org.jboss.virtual.VirtualFile root,
org.jboss.virtual.VirtualFile parent,
StructureMetaData metaData,
VFSStructuralDeployers deployers)
Add all children as candidates |
void |
addCandidateAnnotation(Class<? extends Annotation> annotationClass)
Add candidate annotation. |
protected void |
addChildren(StructureContext context,
org.jboss.virtual.VisitorAttributes attributes)
Add all children as candidates |
protected void |
addChildren(org.jboss.virtual.VirtualFile root,
org.jboss.virtual.VirtualFile parent,
StructureMetaData metaData,
VFSStructuralDeployers deployers,
org.jboss.virtual.VisitorAttributes attributes)
Add all children as candidates |
protected void |
addClassPath(StructureContext structureContext,
org.jboss.virtual.VirtualFile entry,
boolean includeEntry,
boolean includeRootManifestCP,
ContextInfo context)
Add an entry to the context classpath. |
protected void |
applyContextInfo(StructureContext context,
ContextInfo result)
Apply context info. |
protected ContextInfo |
applyMetadataPath(StructureContext context,
String metaDataPath)
Apply metadata on root to create context. |
protected ContextInfo |
applyMetadataPaths(StructureContext context,
String[] metaDataPaths)
Apply metadata on root to create context. |
protected void |
applyStructure(StructureContext context,
ContextInfo contextInfo)
Apply structure metadata on context. |
protected boolean |
checkCandidateAnnotations(StructureContext context,
org.jboss.virtual.VirtualFile... roots)
Check for candidate annotations. |
protected abstract AnnotationEnvironment |
createAnnotationEnvironment(org.jboss.virtual.VirtualFile root)
Create annotation environment |
protected ContextInfo |
createContext(StructureContext context)
Create a context |
protected ContextInfo |
createContext(StructureContext context,
String metaDataPath)
Create a context |
protected ContextInfo |
createContext(StructureContext context,
String[] metaDataPaths)
Create a context |
Set<Class<? extends Annotation>> |
getCandidateAnnotations()
Get the candidate annotations. |
CandidateStructureVisitorFactory |
getCandidateStructureVisitorFactory()
Get the candidateStructureVisitorFactory. |
int |
getRelativeOrder()
Get the relative order |
static String |
getRelativePath(StructureContext context,
org.jboss.virtual.VirtualFile child)
Get the relative path between two virtual files |
static String |
getRelativePath(org.jboss.virtual.VirtualFile parent,
org.jboss.virtual.VirtualFile child)
Get the relative path between two virtual files |
protected static boolean |
isLeaf(org.jboss.virtual.VirtualFile file)
Tests whether the virtual file is a leaf |
boolean |
isSupportsCandidateAnnotations()
Do we support candidate annotations lookup. |
void |
setCandidateAnnotations(Set<Class<? extends Annotation>> candidateAnnotations)
Set the candidate annotations. |
void |
setCandidateStructureVisitorFactory(CandidateStructureVisitorFactory candidateStructureVisitorFactory)
Set the candidateStructureVisitorFactory. |
void |
setContextInfoOrder(Integer contextInfoOrder)
|
void |
setRelativeOrder(int order)
Set the relative order. |
void |
setSupportsCandidateAnnotations(boolean supportsCandidateAnnotations)
Set supportsCandidateAnnotations flag. |
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.vfs.spi.structure.StructureDeployer |
---|
determineStructure |
Field Detail |
---|
protected org.jboss.logging.Logger log
Constructor Detail |
---|
public AbstractStructureDeployer()
Method Detail |
---|
public static final String getRelativePath(StructureContext context, org.jboss.virtual.VirtualFile child)
context
- the structure contextchild
- the child
public static final String getRelativePath(org.jboss.virtual.VirtualFile parent, org.jboss.virtual.VirtualFile child)
parent
- the parentchild
- the child
public int getRelativeOrder()
Ordered
getRelativeOrder
in interface Ordered
public void setRelativeOrder(int order)
Ordered
setRelativeOrder
in interface Ordered
order
- the orderpublic void setContextInfoOrder(Integer contextInfoOrder)
public Set<Class<? extends Annotation>> getCandidateAnnotations()
public void setCandidateAnnotations(Set<Class<? extends Annotation>> candidateAnnotations)
candidateAnnotations
- the candidate annotationspublic void addCandidateAnnotation(Class<? extends Annotation> annotationClass)
annotationClass
- the candidate annotation classpublic boolean isSupportsCandidateAnnotations()
StructureDeployer
isSupportsCandidateAnnotations
in interface StructureDeployer
public void setSupportsCandidateAnnotations(boolean supportsCandidateAnnotations)
supportsCandidateAnnotations
- the support candidate annotations flagpublic CandidateStructureVisitorFactory getCandidateStructureVisitorFactory()
public void setCandidateStructureVisitorFactory(CandidateStructureVisitorFactory candidateStructureVisitorFactory)
candidateStructureVisitorFactory
- the candidateStructureVisitorFactory.
IllegalArgumentException
- for a null candidate structureprotected void addClassPath(StructureContext structureContext, org.jboss.virtual.VirtualFile entry, boolean includeEntry, boolean includeRootManifestCP, ContextInfo context) throws IOException
structureContext
- - the structure contextentry
- - the candidate file to add as a classpath entryincludeEntry
- - a flag indicating if the entry should be added to
the classpathincludeRootManifestCP
- - a flag indicating if the entry metainf
manifest classpath should be included.context
- - the context to populate
IOException
- on any IO errorprotected abstract AnnotationEnvironment createAnnotationEnvironment(org.jboss.virtual.VirtualFile root)
root
- the deployment root
protected boolean checkCandidateAnnotations(StructureContext context, org.jboss.virtual.VirtualFile... roots)
context
- the structure contextroots
- the roots to check
protected void addAllChildren(StructureContext context) throws Exception
context
- the structure context
Exception
- for any errorprotected void addChildren(StructureContext context, org.jboss.virtual.VisitorAttributes attributes) throws Exception
context
- the structure contextattributes
- the visitor attributes uses VisitorAttributes.DEFAULT
when null
Exception
- for any errorprotected void addAllChildren(org.jboss.virtual.VirtualFile root, org.jboss.virtual.VirtualFile parent, StructureMetaData metaData, VFSStructuralDeployers deployers) throws Exception
root
- the root contextparent
- the parent contextmetaData
- the structure meta datadeployers
- the structure deployers
Exception
- for any errorprotected void addChildren(org.jboss.virtual.VirtualFile root, org.jboss.virtual.VirtualFile parent, StructureMetaData metaData, VFSStructuralDeployers deployers, org.jboss.virtual.VisitorAttributes attributes) throws Exception
root
- the root contextparent
- the parent contextmetaData
- the structure meta datadeployers
- the structure deployersattributes
- the visitor attributes uses VisitorAttributes.DEFAULT
when null
Exception
- for any errorprotected static boolean isLeaf(org.jboss.virtual.VirtualFile file) throws IOException
file
- the virtual file
IOException
- for any errorprotected ContextInfo createContext(StructureContext context)
context
- the structure context
IllegalArgumentException
- for a null root or structure metaDataprotected ContextInfo createContext(StructureContext context, String metaDataPath)
context
- the structure contextmetaDataPath
- the metadata path
IllegalArgumentException
- for a null root or structure metaDataprotected ContextInfo applyMetadataPath(StructureContext context, String metaDataPath)
context
- the contextmetaDataPath
- the metadata path
protected ContextInfo createContext(StructureContext context, String[] metaDataPaths)
context
- the structure contextmetaDataPaths
- the metadata paths
IllegalArgumentException
- for a null root or structure metaDataprotected ContextInfo applyMetadataPaths(StructureContext context, String[] metaDataPaths)
context
- the structure contextmetaDataPaths
- the metadata paths
protected void applyStructure(StructureContext context, ContextInfo contextInfo)
context
- the structure contextcontextInfo
- the new created contextprotected void applyContextInfo(StructureContext context, ContextInfo result)
context
- the structure contextresult
- the new context info
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |