OsglConfig (Java Tool 1.26.2 API)

java.lang.Object
- org.osgl.OsglConfig

```
public class OsglConfig
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static StringReplace`	`DEF_STRING_REPLACE` Default string replace logic
`static StringSearch`	`DEF_STRING_SEARCH` Default string search logic
`static Lang.Function<Class,?>`	`INSTANCE_FACTORY`
`static String`	`OSGL_EXTENSION_LIST`

Constructor Summary

Constructors
Constructor and Description

OsglConfig()

Constructors
Constructor and Description
`OsglConfig()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addGlobalMappingFilter(String filterSpec)` Register a global mapping filter.
`static void`	`addGlobalMappingFilters(Collection<String> filterSpecs)` Register global mapping filters
`static void`	`addGlobalMappingFilters(String filterSpec, String... filterSpecs)` Register global mapping filters.
`static Lang.Predicate<Readable>`	`binaryDataProbe()`
`static int`	`getBiglineIteratorBufSize()`
`static int`	`getThreadLocalByteArrayBufferInitSize()`
`static int`	`getThreadLocalByteArrayBufferLimit()`
`static int`	`getThreadLocalCharBufferInitSize()`
`static int`	`getThreadLocalCharBufferLimit()`
`static Lang.Function<Class,?>`	`globalInstanceFactory()`
`static boolean`	`globalMappingFilter_shouldIgnore(String s)` Check if a field name or map key should be ignored by global filter in mapping process.
`static CacheService`	`internalCache()`
`static boolean`	`isSingleton(Object o)`
`static void`	`registerBinaryDataProbe(Lang.Predicate<Readable> probe)`
`static void`	`registerExtensions()`
`static void`	`registerGlobalInstanceFactory(Lang.Function<Class,?> instanceFactory)`
`static void`	`registerImmutableClassNames(Collection<String> immutableClassNames)`
`static void`	`registerImmutableClassPredicate(Lang.Predicate<Class> predicate)`
`static void`	`setBiglineIteratorBufSize(int size)`
`static void`	`setInternalCache(CacheService cache)`
`static void`	`setSingletonChecker(Lang.Predicate singletonChecker)`
`static void`	`setThreadLocalBufferLimit(int limit)`
`static void`	`setThreadLocalByteArrayBufferInitSize(int size)`
`static void`	`setThreadLocalByteArrayBufferLimit(int limit)`
`static void`	`setThreadLocalCharBufferInitSize(int size)`
`static void`	`setThreadLocalCharBufferLimit(int limit)`
`static void`	`setXmlListItemTag(String tag)`
`static void`	`setXmlRootTag(String tag)`
`static String`	`xmlListItemTag()`
`static String`	`xmlRootTag()`

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

Field Detail

OSGL_EXTENSION_LIST

public static final String OSGL_EXTENSION_LIST

See Also:: Constant Field Values

DEF_STRING_SEARCH

public static StringSearch DEF_STRING_SEARCH

Default string search logic

DEF_STRING_REPLACE

public static StringReplace DEF_STRING_REPLACE

Default string replace logic

INSTANCE_FACTORY

public static Lang.Function<Class,?> INSTANCE_FACTORY

Constructor Detail
- OsglConfig
```
public OsglConfig()
```

Method Detail
- setInternalCache
```
public static void setInternalCache(CacheService cache)
```
- internalCache
```
public static CacheService internalCache()
```
- globalInstanceFactory
```
public static Lang.Function<Class,?> globalInstanceFactory()
```
- setSingletonChecker
```
public static void setSingletonChecker(Lang.Predicate singletonChecker)
```
- isSingleton
```
public static boolean isSingleton(Object o)
```
- registerGlobalInstanceFactory
```
public static void registerGlobalInstanceFactory(Lang.Function<Class,?> instanceFactory)
```
- registerImmutableClassNames
```
public static void registerImmutableClassNames(Collection<String> immutableClassNames)
```
- registerImmutableClassPredicate
```
public static void registerImmutableClassPredicate(Lang.Predicate<Class> predicate)
```
- globalMappingFilter_shouldIgnore
```
public static boolean globalMappingFilter_shouldIgnore(String s)
```
  Check if a field name or map key should be ignored by global filter in mapping process.
  
  Parameters:
  
  s - a field name or map key
  
  Returns:
  
  true if the field name or map key should be ignored in mapping process.
- addGlobalMappingFilters
```
public static void addGlobalMappingFilters(String filterSpec,
                                           String... filterSpecs)
```
  Register global mapping filters.
  
  Parameters:
  
  filterSpec - the first filter spec
  
  filterSpecs - other filter specs
  
  See Also:
  
  addGlobalMappingFilter(String)
- addGlobalMappingFilters
```
public static void addGlobalMappingFilters(Collection<String> filterSpecs)
```
  Register global mapping filters
  
  Parameters:
  
  filterSpecs - A collection of filter specs
  
  See Also:
  
  addGlobalMappingFilter(String)
- addGlobalMappingFilter
```
public static void addGlobalMappingFilter(String filterSpec)
```
  Register a global mapping filter. Unlike normal mapping filter, global mapping filter spec
  - checks only immediate level field name or map key
  - it is always a black list filter
  - it supports different matching verb:
    - contains:<payload> - if test string contains payload then it shall be ignored
    - starts:<payload> - if test string starts with payload then it shall be ignored
    - ends:<payload> - if test string ends with payload then it shall be ignored
    - reg:<payload> - if test string matches reg exp pattern payload then it shall be ignored
  - if the filter spec dose not fall in the above category, then it is added into a set, and if any test string exactly matches any item in that set, it shall be ignored.
  Parameters:
  
  filterSpec - the filter spec. It can contains multiple filter specs separated by ,
- setThreadLocalBufferLimit
```
public static void setThreadLocalBufferLimit(int limit)
```
- setThreadLocalCharBufferLimit
```
public static void setThreadLocalCharBufferLimit(int limit)
```
- getThreadLocalCharBufferLimit
```
public static int getThreadLocalCharBufferLimit()
```
- setThreadLocalCharBufferInitSize
```
public static void setThreadLocalCharBufferInitSize(int size)
```
- getThreadLocalCharBufferInitSize
```
public static int getThreadLocalCharBufferInitSize()
```
- setThreadLocalByteArrayBufferLimit
```
public static void setThreadLocalByteArrayBufferLimit(int limit)
```
- getThreadLocalByteArrayBufferLimit
```
public static int getThreadLocalByteArrayBufferLimit()
```
- setThreadLocalByteArrayBufferInitSize
```
public static void setThreadLocalByteArrayBufferInitSize(int size)
```
- getThreadLocalByteArrayBufferInitSize
```
public static int getThreadLocalByteArrayBufferInitSize()
```
- registerExtensions
```
public static void registerExtensions()
```
- binaryDataProbe
```
public static Lang.Predicate<Readable> binaryDataProbe()
```
- registerBinaryDataProbe
```
public static void registerBinaryDataProbe(Lang.Predicate<Readable> probe)
```
- setXmlRootTag
```
public static void setXmlRootTag(String tag)
```
- xmlRootTag
```
public static String xmlRootTag()
```
- setXmlListItemTag
```
public static void setXmlListItemTag(String tag)
```
- xmlListItemTag
```
public static String xmlListItemTag()
```
- setBiglineIteratorBufSize
```
public static void setBiglineIteratorBufSize(int size)
```
- getBiglineIteratorBufSize
```
public static int getBiglineIteratorBufSize()
```

Class OsglConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OSGL_EXTENSION_LIST

DEF_STRING_SEARCH

DEF_STRING_REPLACE

INSTANCE_FACTORY

Constructor Detail

OsglConfig

Method Detail

setInternalCache

internalCache

globalInstanceFactory

setSingletonChecker

isSingleton

registerGlobalInstanceFactory

registerImmutableClassNames

registerImmutableClassPredicate

globalMappingFilter_shouldIgnore

addGlobalMappingFilters

addGlobalMappingFilters

addGlobalMappingFilter

setThreadLocalBufferLimit

setThreadLocalCharBufferLimit

getThreadLocalCharBufferLimit

setThreadLocalCharBufferInitSize

getThreadLocalCharBufferInitSize

setThreadLocalByteArrayBufferLimit

getThreadLocalByteArrayBufferLimit

setThreadLocalByteArrayBufferInitSize

getThreadLocalByteArrayBufferInitSize

registerExtensions

binaryDataProbe

registerBinaryDataProbe

setXmlRootTag

xmlRootTag

setXmlListItemTag

xmlListItemTag

setBiglineIteratorBufSize

getBiglineIteratorBufSize