Module ch.qos.logback.core

Package ch.qos.logback.core.util

Class OptionHelper

java.lang.Object

ch.qos.logback.core.util.OptionHelper

public class OptionHelper
extends Object

Author:

Ceki Gulcu

Constructor Summary

Constructors

Constructor	Description
OptionHelper()

Method Summary

Modifier and Type	Method	Description
static String[]	extractDefaultReplacement(String key)	Return a String[] of size two.
static String	getEnv(String key)	Lookup a key from the environment.
static Properties	getSystemProperties()	Very similar to System.getProperties() except that the SecurityException is absorbed.
static String	getSystemProperty(String key)	Very similar to System.getProperty except that the SecurityException is absorbed.
static String	getSystemProperty(String key, String def)	Very similar to System.getProperty except that the SecurityException is absorbed.
static Object	instantiateByClassName(String className, Class<?> superClass, Context context)
static Object	instantiateByClassName(String className, Class<?> superClass, ClassLoader classLoader)
static Object	instantiateByClassNameAndParameter(String className, Class<?> superClass, Context context, Class<?> type, Object param)
static Object	instantiateByClassNameAndParameter(String className, Class<?> superClass, ClassLoader classLoader, Class<?> type, Object parameter)
static Object	instantiateClassWithSuperclassRestriction(Class<?> classObj, Class<?> superClass)
static boolean	isEmpty(String str)	Deprecated.
static boolean	isNotEmtpy(Object[] array)
static boolean	isNullOrEmpty(Object[] array)
static boolean	isNullOrEmpty(String str)	Returns true if input str is null or empty.
static boolean	isNullOrEmptyOrAllSpaces(String str)	isNullOrEmpty xisNullOrEmptyOrAllSpaces
static String	propertyLookup(String key, PropertyContainer pc1, PropertyContainer pc2)	Try to lookup the property in the following order: pc1 (the local property container, usually the ModelInterpretationContext) pc2 (usually the context) System properties Environment variables
static void	setSystemProperties(ContextAware contextAware, Properties props)
static void	setSystemProperty(ContextAware contextAware, String key, String value)
static String	substVars(String val, PropertyContainer pc1)
static String	substVars(String input, PropertyContainer pc0, PropertyContainer pc1)	See http://logback.qos.ch/manual/configuration.html#variableSubstitution
static boolean	toBoolean(String value, boolean defaultVal)	If value is "true", then true is returned.
static Boolean	toBooleanObject(String value)	Converts a string representation of a boolean value to a Boolean object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OptionHelper

public OptionHelper()

Method Detail

instantiateByClassName

public static Object instantiateByClassName(String className,
                                            Class<?> superClass,
                                            Context context)
                                     throws IncompatibleClassException,
                                            DynamicClassLoadingException

Throws:

IncompatibleClassException

DynamicClassLoadingException

instantiateByClassNameAndParameter

public static Object instantiateByClassNameAndParameter(String className,
                                                        Class<?> superClass,
                                                        Context context,
                                                        Class<?> type,
                                                        Object param)
                                                 throws IncompatibleClassException,
                                                        DynamicClassLoadingException

Throws:

IncompatibleClassException

DynamicClassLoadingException

instantiateByClassName

public static Object instantiateByClassName(String className,
                                            Class<?> superClass,
                                            ClassLoader classLoader)
                                     throws IncompatibleClassException,
                                            DynamicClassLoadingException

Throws:

IncompatibleClassException

DynamicClassLoadingException

instantiateClassWithSuperclassRestriction

public static Object instantiateClassWithSuperclassRestriction(Class<?> classObj,
                                                               Class<?> superClass)
                                                        throws IncompatibleClassException,
                                                               DynamicClassLoadingException

Throws:

IncompatibleClassException

DynamicClassLoadingException

instantiateByClassNameAndParameter

public static Object instantiateByClassNameAndParameter(String className,
                                                        Class<?> superClass,
                                                        ClassLoader classLoader,
                                                        Class<?> type,
                                                        Object parameter)
                                                 throws IncompatibleClassException,
                                                        DynamicClassLoadingException

Throws:

IncompatibleClassException

DynamicClassLoadingException

substVars

public static String substVars(String val,
                               PropertyContainer pc1)
                        throws ScanException

Throws:

ScanException

See Also:

substVars(String, PropertyContainer, PropertyContainer)

substVars

public static String substVars(String input,
                               PropertyContainer pc0,
                               PropertyContainer pc1)
                        throws ScanException

See http://logback.qos.ch/manual/configuration.html#variableSubstitution

Throws:

ScanException

propertyLookup

public static String propertyLookup(String key,
                                    PropertyContainer pc1,
                                    PropertyContainer pc2)

Try to lookup the property in the following order:

1. pc1 (the local property container, usually the ModelInterpretationContext)
2. pc2 (usually the context)
3. System properties
4. Environment variables

Parameters:

key - the property key

pc1 - the first property container to search

pc2 - the second property container to search

Returns:

the property value or null if not found

getSystemProperty

public static String getSystemProperty(String key,
                                       String def)

Very similar to System.getProperty except that the SecurityException is absorbed.

Parameters:

key - The key to search for.

def - The default value to return.

Returns:

the string value of the system property, or the default value if there is no property with that key.

getEnv

public static String getEnv(String key)

Lookup a key from the environment.

Parameters:

key -

Returns:

value corresponding to key from the OS environment

getSystemProperty

public static String getSystemProperty(String key)

Very similar to System.getProperty except that the SecurityException is absorbed.

Parameters:

key - The key to search for.

Returns:

the string value of the system property.

setSystemProperties

public static void setSystemProperties(ContextAware contextAware,
                                       Properties props)

setSystemProperty

public static void setSystemProperty(ContextAware contextAware,
                                     String key,
                                     String value)

getSystemProperties

public static Properties getSystemProperties()

Very similar to System.getProperties() except that the SecurityException is absorbed.

Returns:

the system properties

extractDefaultReplacement

public static String[] extractDefaultReplacement(String key)

Return a String[] of size two. The first item containing the key part and the second item containing a default value specified by the user. The second item will be null if no default value is specified.

Parameters:

key -

Returns:

toBooleanObject

public static Boolean toBooleanObject(String value)

Converts a string representation of a boolean value to a Boolean object. If the input string is "true" (case-insensitive), returns Boolean.TRUE. If the input string is "false" (case-insensitive), returns Boolean.FALSE. Returns null if the input string is null, empty, or does not match "true" or "false".

Parameters:

value - the string representation of a boolean value, may be null or empty

Returns:

a Boolean object corresponding to the input string, or null if the input is invalid

toBoolean

public static boolean toBoolean(String value,
                                boolean defaultVal)

If value is "true", then true is returned. If value is "false", then true is returned. Otherwise, defaultVal is returned.

Comparisons are case-insensitive.

Parameters:

value - a string representation of a boolean value

defaultVal - the default value to return if value is null, empty or not a valid boolean value

isEmpty

public static boolean isEmpty(String str)

Deprecated.

Since:

1.3

isNullOrEmpty

public static boolean isNullOrEmpty(String str)

Returns true if input str is null or empty.

Parameters:

str -

Returns:

isNullOrEmptyOrAllSpaces

public static boolean isNullOrEmptyOrAllSpaces(String str)

isNullOrEmpty xisNullOrEmptyOrAllSpaces

Parameters:

str -

Returns:

Since:

1.5.0

isNullOrEmpty

public static final boolean isNullOrEmpty(Object[] array)

isNotEmtpy

public static final boolean isNotEmtpy(Object[] array)