Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.server.service
Interface ErraiServiceConfigurator

All Known Implementing Classes:
ErraiServiceConfiguratorImpl

public interface ErraiServiceConfigurator

The ErraiServiceConfigurator is a template for creating a configuration for a service


Method Summary
 boolean getBooleanProperty(String key)
          Gets the property associated with the key.
 Integer getIntProperty(String key)
          Gets the property associated with the key.
 MetaDataScanner getMetaDataScanner()
          Provides access to the MetaDataScanner that is used to read component annotation meta data.
 String getProperty(String key)
          Gets the property associated with the key
<T> T
getResource(Class<? extends T> resourceClass)
          Gets the resources attached to the specified resource class
 Map<String,ResourceProvider> getResourceProviders()
          Gets the resource providers associated with this configurator
 boolean hasProperty(String key)
          Returns true if the configuration has this key property
 void setProperty(String key, String value)
          Sets a property with the specified key and value
 

Method Detail

getMetaDataScanner

MetaDataScanner getMetaDataScanner()
Provides access to the MetaDataScanner that is used to read component annotation meta data.

Returns:

getResourceProviders

Map<String,ResourceProvider> getResourceProviders()
Gets the resource providers associated with this configurator

Returns:
the resource providers associated with this configurator

getResource

<T> T getResource(Class<? extends T> resourceClass)
Gets the resources attached to the specified resource class

Type Parameters:
T - - the class type
Parameters:
resourceClass - - the class to search the resources for
Returns:
the resource of type T

hasProperty

boolean hasProperty(String key)
Returns true if the configuration has this key property

Parameters:
key - - the property too search for
Returns:
false if the property does not exist

getProperty

String getProperty(String key)
Gets the property associated with the key

Parameters:
key - - the key to search for
Returns:
the property, if it exists, null otherwise

getBooleanProperty

boolean getBooleanProperty(String key)
Gets the property associated with the key. Returns true if the flag is set true, or false if not or if the property is undefined.

Parameters:
key -
Returns:

getIntProperty

Integer getIntProperty(String key)
Gets the property associated with the key. Returns the number if set, or null if not set. Throws a NumberFormatException if the underlying key is not a number.

Parameters:
key -
Returns:

setProperty

void setProperty(String key,
                 String value)
Sets a property with the specified key and value

Parameters:
key - the name of the property.
value - the string value of the property.

Errai 3.0.1-SNAPSHOT

Copyright © 2013-2014 JBoss, a division of Red Hat. All Rights Reserved.