Context (Apache Juneau 7.2.2)

java.lang.Object
- org.apache.juneau.Context

Direct Known Subclasses:

BeanContext, Config, ConfigStore
```
public abstract class Context
extends Object
```
A reusable stateless thread-safe read-only configuration, typically used for creating one-time use Session objects.
Contexts are created through the ContextBuilder.build() method (and subclasses of ContextBuilder).
Subclasses MUST implement the following constructor:
public T(PropertyStore);

Besides that restriction, a context object can do anything you desire.
However, it MUST be thread-safe and all fields should be declared final to prevent modification.
It should NOT be used for storing temporary or state information.

See Also:

PropertyStore

Constructor Summary

Constructors
Constructor and Description

Context(PropertyStore ps)
Constructor for this class.

Constructors
Constructor and Description
`Context(PropertyStore ps)` Constructor for this class.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectMap`	`asMap()` Returns the properties defined on this bean context as a simple map for debugging purposes.
`ContextBuilder`	`builder()` Creates a builder from this context object.
`abstract SessionArgs`	`createDefaultSessionArgs()` Defines default session arguments used when calling the `createSession()` method.
`Session`	`createSession()` Create a new bean session based on the properties defined on this context.
`abstract Session`	`createSession(SessionArgs args)` Create a new session based on the properties defined on this context combined with the specified runtime args.
`boolean`	`equals(Object o)`
`<T> T[]`	`getArrayProperty(String key, Class<T> eType)` Returns the array property value with the specified name.
`<T> T[]`	`getArrayProperty(String key, Class<T> eType, T[] def)` Returns the array property value with the specified name.
`Boolean`	`getBooleanProperty(String key, Boolean def)` Shortcut for calling `getProperty(key, Boolean.class, def)`.
`Class<?>[]`	`getClassArrayProperty(String key)` Returns the class array property with the specified name.
`Class<?>[]`	`getClassArrayProperty(String key, Class<?>[] def)` Returns the class array property with the specified name.
`<T> Class<T>[]`	`getClassArrayProperty(String key, Class<T> eType)` Returns the class array property with the specified name.
`List<Class<?>>`	`getClassListProperty(String key)` Returns the class list property with the specified name.
`<T> List<Class<T>>`	`getClassListProperty(String key, Class<T> eType)` Returns the class list property with the specified name.
`Map<String,Class<?>>`	`getClassMapProperty(String key)` Returns the class map property with the specified name.
`<T> Map<String,Class<T>>`	`getClassMapProperty(String key, Class<T> eType)` Returns the class map property with the specified name.
`<T> Class<? extends T>`	`getClassProperty(String key, Class<T> type, Class<? extends T> def)` Returns the class property with the specified name.
`Set<Class<?>>`	`getClassSetProperty(String key)` Returns the class set property with the specified name.
`<T> Set<Class<T>>`	`getClassSetProperty(String key, Class<T> eType)` Returns the class set property with the specified name.
`<T> T[]`	`getInstanceArrayProperty(String key, Class<T> type, T[] def)` Returns the specified property as an array of instantiated objects.
`<T> T[]`	`getInstanceArrayProperty(String key, Class<T> type, T[] def, boolean fuzzyArgs, Object... args)` Returns the specified property as an array of instantiated objects.
`<T> T[]`	`getInstanceArrayProperty(String key, Object outer, Class<T> type, T[] def, boolean fuzzyArgs, Object... args)` Returns the specified property as an array of instantiated objects.
`<T> T`	`getInstanceProperty(String key, Class<T> type, Object def)` Returns an instance of the specified class, string, or object property.
`<T> T`	`getInstanceProperty(String key, Class<T> type, Object def, boolean fuzzyArgs, Object... args)` Returns an instance of the specified class, string, or object property.
`<T> T`	`getInstanceProperty(String key, Object outer, Class<T> type, Object def, boolean fuzzyArgs, Object... args)` Returns an instance of the specified class, string, or object property.
`Integer`	`getIntegerProperty(String key, Integer def)` Shortcut for calling `getProperty(key, Integer.class, def)`.
`<T> List<T>`	`getListProperty(String key, Class<T> eType)` Returns the list property with the specified name.
`<T> List<T>`	`getListProperty(String key, Class<T> eType, List<T> def)` Returns the list property with the specified name.
`Long`	`getLongProperty(String key, Long def)` Shortcut for calling `getProperty(key, Long.class, def)`.
`<T> Map<String,T>`	`getMapProperty(String key, Class<T> eType)` Returns the map property with the specified name.
`Object`	`getProperty(String key)` Returns the raw property value with the specified name.
`<T> T`	`getProperty(String key, Class<T> c, T def)` Returns the property value with the specified name.
`Set<String>`	`getPropertyKeys(String group)` Returns the keys found in the specified property group.
`PropertyStore`	`getPropertyStore()` Returns the property store associated with this context.
`<T> Set<T>`	`getSetProperty(String key, Class<T> eType)` Returns the set property with the specified name.
`<T> Set<T>`	`getSetProperty(String key, Class<T> eType, Set<T> def)` Returns the set property with the specified name.
`String`	`getStringProperty(String key, String def)` Shortcut for calling `getProperty(key, String.class, def)`.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Context
```
public Context(PropertyStore ps)
```
    Constructor for this class.
    Subclasses MUST implement the same public constructor.
    
    Parameters:
    
    ps - The read-only configuration for this context object.
- Method Detail
  - getProperty
```
public Object getProperty(String key)
```
    Returns the raw property value with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value, or null if it doesn't exist.
  - getProperty
```
public final <T> T getProperty(String key,
                               Class<T> c,
                               T def)
```
    Returns the property value with the specified name.
    
    Parameters:
    
    key - The property name.
    
    c - The class to cast or convert the value to.
    
    def - The default value.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getBooleanProperty
```
public final Boolean getBooleanProperty(String key,
                                        Boolean def)
```
    Shortcut for calling getProperty(key, Boolean.class, def).
    
    Parameters:
    
    key - The property name.
    
    def - The default value.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getIntegerProperty
```
public final Integer getIntegerProperty(String key,
                                        Integer def)
```
    Shortcut for calling getProperty(key, Integer.class, def).
    
    Parameters:
    
    key - The property name.
    
    def - The default value.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getLongProperty
```
public final Long getLongProperty(String key,
                                  Long def)
```
    Shortcut for calling getProperty(key, Long.class, def).
    
    Parameters:
    
    key - The property name.
    
    def - The default value.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getStringProperty
```
public final String getStringProperty(String key,
                                      String def)
```
    Shortcut for calling getProperty(key, String.class, def).
    
    Parameters:
    
    key - The property name.
    
    def - The default value.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getClassProperty
```
public final <T> Class<? extends T> getClassProperty(String key,
                                                     Class<T> type,
                                                     Class<? extends T> def)
```
    Returns the class property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default value.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getArrayProperty
```
public final <T> T[] getArrayProperty(String key,
                                      Class<T> eType)
```
    Returns the array property value with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getArrayProperty
```
public final <T> T[] getArrayProperty(String key,
                                      Class<T> eType,
                                      T[] def)
```
    Returns the array property value with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    def - The default value.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getClassArrayProperty
```
public final Class<?>[] getClassArrayProperty(String key)
```
    Returns the class array property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value, or an empty array if it doesn't exist.
  - getClassArrayProperty
```
public final Class<?>[] getClassArrayProperty(String key,
                                              Class<?>[] def)
```
    Returns the class array property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    def - The default value.
    
    Returns:
    
    The property value, or an empty array if it doesn't exist.
  - getClassArrayProperty
```
public final <T> Class<T>[] getClassArrayProperty(String key,
                                                  Class<T> eType)
```
    Returns the class array property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value, or an empty array if it doesn't exist.
  - getSetProperty
```
public final <T> Set<T> getSetProperty(String key,
                                       Class<T> eType)
```
    Returns the set property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashSet, or an empty set if it doesn't exist.
  - getSetProperty
```
public final <T> Set<T> getSetProperty(String key,
                                       Class<T> eType,
                                       Set<T> def)
```
    Returns the set property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    def - The default value if the property doesn't exist or is empty.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashSet, or the default value if it doesn't exist or is empty.
  - getClassSetProperty
```
public final Set<Class<?>> getClassSetProperty(String key)
```
    Returns the class set property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashSet, or an empty set if it doesn't exist.
  - getClassSetProperty
```
public final <T> Set<Class<T>> getClassSetProperty(String key,
                                                   Class<T> eType)
```
    Returns the class set property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashSet, or an empty set if it doesn't exist.
  - getListProperty
```
public final <T> List<T> getListProperty(String key,
                                         Class<T> eType)
```
    Returns the list property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable ArrayList, or an empty list if it doesn't exist.
  - getListProperty
```
public final <T> List<T> getListProperty(String key,
                                         Class<T> eType,
                                         List<T> def)
```
    Returns the list property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    def - The default value if the property doesn't exist or is empty.
    
    Returns:
    
    The property value as an unmodifiable ArrayList, or the default value if it doesn't exist or is empty.
  - getClassListProperty
```
public final List<Class<?>> getClassListProperty(String key)
```
    Returns the class list property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value as an unmodifiable ArrayList, or an empty list if it doesn't exist.
  - getClassListProperty
```
public final <T> List<Class<T>> getClassListProperty(String key,
                                                     Class<T> eType)
```
    Returns the class list property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable ArrayList, or an empty list if it doesn't exist.
  - getMapProperty
```
public final <T> Map<String,T> getMapProperty(String key,
                                              Class<T> eType)
```
    Returns the map property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashMap, or an empty map if it doesn't exist.
  - getClassMapProperty
```
public final Map<String,Class<?>> getClassMapProperty(String key)
```
    Returns the class map property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashMap, or an empty map if it doesn't exist.
  - getClassMapProperty
```
public final <T> Map<String,Class<T>> getClassMapProperty(String key,
                                                          Class<T> eType)
```
    Returns the class map property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashMap, or an empty map if it doesn't exist.
  - getInstanceProperty
```
public <T> T getInstanceProperty(String key,
                                 Class<T> type,
                                 Object def)
```
    Returns an instance of the specified class, string, or object property.
    If instantiating a class, assumes the class has a no-arg constructor. Otherwise, throws a runtime exception.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default value if the property doesn't exist.
    Can either be an instance of T, or a Class<? extends T>, or null.
    
    Returns:
    
    A new property instance.
  - getInstanceProperty
```
public <T> T getInstanceProperty(String key,
                                 Class<T> type,
                                 Object def,
                                 boolean fuzzyArgs,
                                 Object... args)
```
    Returns an instance of the specified class, string, or object property.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default value if the property doesn't exist.
    Can either be an instance of T, or a Class<? extends T>.
    
    fuzzyArgs - Use fuzzy constructor arg matching.
    When true, constructor args can be in any order and extra args are ignored.
    No-arg constructors are also used if no other constructors are found.
    
    args - Arguments to pass to the constructor. Constructors matching the arguments are always used before no-arg constructors.
    
    Returns:
    
    A new property instance.
  - getInstanceProperty
```
public <T> T getInstanceProperty(String key,
                                 Object outer,
                                 Class<T> type,
                                 Object def,
                                 boolean fuzzyArgs,
                                 Object... args)
```
    Returns an instance of the specified class, string, or object property.
    
    Parameters:
    
    key - The property name.
    
    outer - The outer object if the class we're instantiating is an inner class.
    
    type - The class type of the property.
    
    def - The default value if the property doesn't exist.
    Can either be an instance of T, or a Class<? extends T>.
    
    fuzzyArgs - Use fuzzy constructor arg matching.
    When true, constructor args can be in any order and extra args are ignored.
    No-arg constructors are also used if no other constructors are found.
    
    args - Arguments to pass to the constructor. Constructors matching the arguments are always used before no-arg constructors.
    
    Returns:
    
    A new property instance.
  - getInstanceArrayProperty
```
public <T> T[] getInstanceArrayProperty(String key,
                                        Class<T> type,
                                        T[] def)
```
    Returns the specified property as an array of instantiated objects.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default object to return if the property doesn't exist.
    
    Returns:
    
    A new property instance.
  - getInstanceArrayProperty
```
public <T> T[] getInstanceArrayProperty(String key,
                                        Class<T> type,
                                        T[] def,
                                        boolean fuzzyArgs,
                                        Object... args)
```
    Returns the specified property as an array of instantiated objects.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default object to return if the property doesn't exist.
    
    fuzzyArgs - Use fuzzy constructor arg matching.
    When true, constructor args can be in any order and extra args are ignored.
    No-arg constructors are also used if no other constructors are found.
    
    args - Arguments to pass to the constructor. Constructors matching the arguments are always used before no-arg constructors.
    
    Returns:
    
    A new property instance.
  - getInstanceArrayProperty
```
public <T> T[] getInstanceArrayProperty(String key,
                                        Object outer,
                                        Class<T> type,
                                        T[] def,
                                        boolean fuzzyArgs,
                                        Object... args)
```
    Returns the specified property as an array of instantiated objects.
    
    Parameters:
    
    key - The property name.
    
    outer - The outer object if the class we're instantiating is an inner class.
    
    type - The class type of the property.
    
    def - The default object to return if the property doesn't exist.
    
    fuzzyArgs - Use fuzzy constructor arg matching.
    When true, constructor args can be in any order and extra args are ignored.
    No-arg constructors are also used if no other constructors are found.
    
    args - Arguments to pass to the constructor. Constructors matching the arguments are always used before no-arg constructors.
    
    Returns:
    
    A new property instance.
  - getPropertyKeys
```
public Set<String> getPropertyKeys(String group)
```
    Returns the keys found in the specified property group.
    The keys are NOT prefixed with group names.
    
    Parameters:
    
    group - The group name.
    
    Returns:
    
    The set of property keys, or an empty set if the group was not found.
  - getPropertyStore
```
@BeanIgnore
public final PropertyStore getPropertyStore()
```
    Returns the property store associated with this context.
    
    Returns:
    
    The property store associated with this context.
  - builder
```
public ContextBuilder builder()
```
    Creates a builder from this context object.
    Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.
    
    Returns:
    
    A new ContextBuilder object.
  - createSession
```
public Session createSession()
```
    Create a new bean session based on the properties defined on this context.
    Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.
    
    Returns:
    
    A new session object.
  - createSession
```
public abstract Session createSession(SessionArgs args)
```
    Create a new session based on the properties defined on this context combined with the specified runtime args.
    Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.
    
    Parameters:
    
    args - The session arguments.
    
    Returns:
    
    A new session object.
  - createDefaultSessionArgs
```
public abstract SessionArgs createDefaultSessionArgs()
```
    Defines default session arguments used when calling the createSession() method.
    
    Returns:
    
    A SessionArgs object, possibly a read-only reusable instance.
  - asMap
```
@BeanIgnore
public ObjectMap asMap()
```
    Returns the properties defined on this bean context as a simple map for debugging purposes.
    
    Returns:
    
    A new map containing the properties defined on this context.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Context

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Context

Method Detail

getProperty

getProperty

getBooleanProperty

getIntegerProperty

getLongProperty

getStringProperty

getClassProperty

getArrayProperty

getArrayProperty

getClassArrayProperty

getClassArrayProperty

getClassArrayProperty

getSetProperty

getSetProperty

getClassSetProperty

getClassSetProperty

getListProperty

getListProperty

getClassListProperty

getClassListProperty

getMapProperty

getClassMapProperty

getClassMapProperty

getInstanceProperty

getInstanceProperty

getInstanceProperty

getInstanceArrayProperty

getInstanceArrayProperty

getInstanceArrayProperty

getPropertyKeys

getPropertyStore

builder

createSession

createSession

createDefaultSessionArgs

asMap

hashCode

equals

toString