org.jboss.deployers.spi.structure
Interface ContextInfo

All Superinterfaces:
PredeterminedManagedObjectAttachments, Serializable
All Known Implementing Classes:
ContextInfoImpl

public interface ContextInfo
extends PredeterminedManagedObjectAttachments, Serializable

An encapsulation of context information

Version:
$Revision: 1.1$
Author:
Scott.Stark@jboss.org, adrian@jboss.org, ales.justin@jboss.org

Field Summary
static String DEFAULT_METADATA_PATH
          The default metadata path
 
Method Summary
 void addClassPathEntry(ClassPathEntry entry)
          Add a class path entry
 void addMetaDataPath(String path)
          Add the metaDataPath.
 List<ClassPathEntry> getClassPath()
          Get the classpath locations within the context
 String getComparatorClassName()
          The comparator class name, the class must implement
 List<String> getMetaDataPath()
          Get the logical path of the metdata location.
 ModificationType getModificationType()
          Get the modification type.
 String getPath()
          Get the logical path of the context
 int getRelativeOrder()
          Get the relative order of this context
 void setComparatorClassName(String className)
          The comparator class name, the class must implement
 void setModificationType(ModificationType modificationType)
          Set the modification type.
 void setRelativeOrder(int relativeOrder)
          Set the relative order of this context
 
Methods inherited from interface org.jboss.deployers.spi.attachments.PredeterminedManagedObjectAttachments
getPredeterminedManagedObjects, setPredeterminedManagedObjects
 

Field Detail

DEFAULT_METADATA_PATH

static final String DEFAULT_METADATA_PATH
The default metadata path

See Also:
Constant Field Values
Method Detail

getPath

String getPath()
Get the logical path of the context

Returns:
the logical path

getMetaDataPath

List<String> getMetaDataPath()
Get the logical path of the metdata location.

Returns:
the path of the metdata location.

addMetaDataPath

void addMetaDataPath(String path)
Add the metaDataPath.

Parameters:
path - the metaDataPath.
Throws:
IllegalArgumentException - for a null path

getClassPath

List<ClassPathEntry> getClassPath()
Get the classpath locations within the context

Returns:
the possibly null context classpath

addClassPathEntry

void addClassPathEntry(ClassPathEntry entry)
Add a class path entry

Parameters:
entry - the entry to add
Throws:
IllegalArgumentException - for a null entry

getRelativeOrder

int getRelativeOrder()
Get the relative order of this context

Returns:
the relative order

setRelativeOrder

void setRelativeOrder(int relativeOrder)
Set the relative order of this context

Parameters:
relativeOrder - the relative order

getComparatorClassName

String getComparatorClassName()
The comparator class name, the class must implement
 java.util.Comparator
 
If the class has a public static field called "INSTANCE" then that will be used rather than creating a new object.

If none is given then the deployments are ordered by their relative order and then path/simple name.

Returns:
the comparator class name

setComparatorClassName

void setComparatorClassName(String className)
The comparator class name, the class must implement

Parameters:
className - the comparator class name

getModificationType

ModificationType getModificationType()
Get the modification type.

Returns:
the modification type

setModificationType

void setModificationType(ModificationType modificationType)
Set the modification type.

Parameters:
modificationType - the modification type


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