|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jomc.modlet.DefaultModletProvider
public class DefaultModletProvider
Default ModletProvider
implementation.
ModelContext.findModlets()
Field Summary | |
---|---|
static String |
ENABLED_ATTRIBUTE_NAME
Constant for the name of the model context attribute backing property enabled . |
static String |
MODLET_LOCATION_ATTRIBUTE_NAME
Constant for the name of the model context attribute backing property modletLocation . |
static String |
VALIDATING_ATTRIBUTE_NAME
Constant for the name of the model context attribute backing property validating . |
Constructor Summary | |
---|---|
DefaultModletProvider()
Creates a new DefaultModletProvider instance. |
Method Summary | |
---|---|
Modlets |
findModlets(ModelContext context)
Searches a given context for Modlets . |
Modlets |
findModlets(ModelContext context,
String location)
Searches a given context for Modlets . |
static String |
getDefaultModletLocation()
Gets the default location searched for Modlet resources. |
String |
getModletLocation()
Gets the location searched for Modlet resources. |
static boolean |
isDefaultEnabled()
Gets a flag indicating the provider is enabled by default. |
static boolean |
isDefaultValidating()
Gets a flag indicating the provider is validating resources by default. |
boolean |
isEnabled()
Gets a flag indicating the provider is enabled. |
boolean |
isValidating()
Gets a flag indicating the provider is validating resources. |
static void |
setDefaultEnabled(Boolean value)
Sets the flag indicating the provider is enabled by default. |
static void |
setDefaultModletLocation(String value)
Sets the default location searched for Modlet resources. |
static void |
setDefaultValidating(Boolean value)
Sets the flag indicating the provider is validating resources by default. |
void |
setEnabled(Boolean value)
Sets the flag indicating the provider is enabled. |
void |
setModletLocation(String value)
Sets the location searched for Modlet resources. |
void |
setValidating(Boolean value)
Sets the flag indicating the provider is validating resources. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String ENABLED_ATTRIBUTE_NAME
enabled
.
findModlets(org.jomc.modlet.ModelContext)
,
ModelContext.getAttribute(java.lang.String)
,
Constant Field Valuespublic static final String MODLET_LOCATION_ATTRIBUTE_NAME
modletLocation
.
findModlets(org.jomc.modlet.ModelContext)
,
ModelContext.getAttribute(java.lang.String)
,
Constant Field Valuespublic static final String VALIDATING_ATTRIBUTE_NAME
validating
.
findModlets(org.jomc.modlet.ModelContext, java.lang.String)
,
ModelContext.getAttribute(java.lang.String)
,
Constant Field ValuesConstructor Detail |
---|
public DefaultModletProvider()
DefaultModletProvider
instance.
Method Detail |
---|
public static boolean isDefaultEnabled()
The default enabled flag is controlled by system property
org.jomc.modlet.DefaultModletProvider.defaultEnabled
holding a value indicating the provider is
enabled by default. If that property is not set, the true
default is returned.
true
, if the provider is enabled by default; false
, if the provider is disabled by
default.isEnabled()
,
setDefaultEnabled(java.lang.Boolean)
public static void setDefaultEnabled(Boolean value)
value
- The new value of the flag indicating the provider is enabled by default or null
.isDefaultEnabled()
public final boolean isEnabled()
true
, if the provider is enabled; false
, if the provider is disabled.isDefaultEnabled()
,
setEnabled(java.lang.Boolean)
public final void setEnabled(Boolean value)
value
- The new value of the flag indicating the provider is enabled or null
.isEnabled()
public static String getDefaultModletLocation()
Modlet
resources.
The default Modlet
location is controlled by system property
org.jomc.modlet.DefaultModletProvider.defaultModletLocation
holding the location to search for
Modlet
resources by default. If that property is not set, the META-INF/jomc-modlet.xml
default is
returned.
Modlet
resources by default.setDefaultModletLocation(java.lang.String)
public static void setDefaultModletLocation(String value)
Modlet
resources.
value
- The new default location to search for Modlet
resources or null
.getDefaultModletLocation()
public final String getModletLocation()
Modlet
resources.
Modlet
resources.getDefaultModletLocation()
,
setModletLocation(java.lang.String)
public final void setModletLocation(String value)
Modlet
resources.
value
- The new location to search for Modlet
resources or null
.getModletLocation()
public static boolean isDefaultValidating()
The default validating flag is controlled by system property
org.jomc.modlet.DefaultModletProvider.defaultValidating
holding a value indicating the provider is
validating resources by default. If that property is not set, the true
default is returned.
true
, if the provider is validating resources by default; false
, if the provider is not
validating resources by default.isValidating()
,
setDefaultValidating(java.lang.Boolean)
public static void setDefaultValidating(Boolean value)
value
- The new value of the flag indicating the provider is validating resources by default or
null
.isDefaultValidating()
public final boolean isValidating()
true
, if the provider is validating resources; false
, if the provider is not validating
resources.isDefaultValidating()
,
setValidating(java.lang.Boolean)
public final void setValidating(Boolean value)
value
- The new value of the flag indicating the provider is validating resources or null
.isValidating()
public Modlets findModlets(ModelContext context, String location) throws ModelException
Modlets
.
context
- The context to search for Modlets
.location
- The location to search at.
Modlets
found at location
in context
or null
, if no Modlets
are found.
NullPointerException
- if context
or location
is null
.
ModelException
- if searching the context fails.isValidating()
,
VALIDATING_ATTRIBUTE_NAME
public Modlets findModlets(ModelContext context) throws ModelException
Modlets
.
findModlets
in interface ModletProvider
context
- The context to search for Modlets
.
Modlets
found in the context or null
, if no Modlets
are found or the provider
is disabled.
ModelException
- if searching the context fails.isEnabled()
,
getModletLocation()
,
findModlets(org.jomc.modlet.ModelContext, java.lang.String)
,
ENABLED_ATTRIBUTE_NAME
,
MODLET_LOCATION_ATTRIBUTE_NAME
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2005-2012 The JOMC Project. All Rights Reserved. |