SystemProperties (phloc-commons 4.4.4 API)

java.lang.Object
- com.phloc.commons.SystemProperties

```
@Immutable
public final class SystemProperties
extends Object
```
This class wraps all the Java system properties like version number etc.

Author:

Philip Helger

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`containsPropertyName(String sPropertyName)` Check if a system property with the given name exists.
`static Map<String,String>`	`getAllProperties()`
`static Set<String>`	`getAllPropertyNames()`
`static String`	`getFileSeparator()`
`static String`	`getJavaClassPath()`
`static String`	`getJavaClassVersion()`
`static String`	`getJavaHome()`
`static String`	`getJavaLibraryPath()`
`static String`	`getJavaSpecificationUrl()`
`static String`	`getJavaSpecificationVendor()`
`static String`	`getJavaSpecificationVersion()`
`static String`	`getJavaVendor()`
`static String`	`getJavaVendorURL()`
`static String`	`getJavaVersion()`
`static String`	`getJavaVmSpecificationUrl()`
`static String`	`getJavaVmSpecificationVendor()`
`static String`	`getJavaVmSpecificationVersion()`
`static String`	`getJavaVmUrl()`
`static String`	`getJavaVmVendor()`
`static String`	`getJavaVmVersion()`
`static String`	`getLineSeparator()`
`static String`	`getOsArch()`
`static String`	`getOsName()`
`static String`	`getOsVersion()`
`static String`	`getPathSeparator()`
`static String`	`getPropertyValue(String sKey)`
`static String`	`getPropertyValueOrNull(String sKey)`
`static String`	`getTmpDir()`
`static String`	`getUserDir()`
`static String`	`getUserHome()`
`static String`	`getUserName()`
`static int`	`getXMLElementAttributeLimit()`
`static int`	`getXMLEntityExpansionLimit()`
`static int`	`getXMLMaxGeneralEntitySizeLimit()`
`static int`	`getXMLMaxOccur()`
`static int`	`getXMLMaxParameterEntitySizeLimit()`
`static int`	`getXMLTotalEntitySizeLimit()`
`static String`	`removePropertyValue(String sKey)` Remove a system property value under consideration of an eventually present `SecurityManager`.
`static void`	`setPropertyValue(String sKey, String sValue)` Set a system property value under consideration of an eventually present `SecurityManager`.
`static void`	`setXMLElementAttributeLimit(int nElementAttributeLimit)` Limit the number of attributes an element can have
`static void`	`setXMLEntityExpansionLimit(int nEntityExpansionLimit)` Limit the number of entity expansions.
`static void`	`setXMLMaxGeneralEntitySizeLimit(int nMaxGeneralEntitySizeLimit)` Limit the maximum size of any general entities.
`static void`	`setXMLMaxOccur(int nMaxOccur)` Limit the number of contentmodel nodes that may be created when building a grammar for a W3C XML Schema that contains maxOccurs attributes with values other than "unbounded".
`static void`	`setXMLMaxParameterEntitySizeLimit(int nMaxParameterEntitySizeLimit)` Limit the maximum size of any parameter entities, including the result of nesting multiple parameter entities.
`static void`	`setXMLTotalEntitySizeLimit(int nTotalEntitySizeLimit)` Limit the total size of all entities that include general and parameter entities.

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

- Method Detail
  - getPropertyValueOrNull
```
@Nullable
public static String getPropertyValueOrNull(@Nullable
                                     String sKey)
```
  - getPropertyValue
```
@Nullable
public static String getPropertyValue(@Nullable
                               String sKey)
```
  - setPropertyValue
```
public static void setPropertyValue(@Nonnull
                    String sKey,
                    @Nullable
                    String sValue)
```
    Set a system property value under consideration of an eventually present SecurityManager.
    
    Parameters:
    sKey - The key of the system property. May not be null.
    sValue - The value of the system property. If the value is null the property is removed.
  - removePropertyValue
```
@Nullable
public static String removePropertyValue(@Nonnull
                                  String sKey)
```
    Remove a system property value under consideration of an eventually present SecurityManager.
    
    Parameters:
    sKey - The key of the system property to be removed. May not be null.
    
    Returns:
    the previous string value of the system property, or null if there was no property with that key.
  - getJavaVersion
```
@Nullable
public static String getJavaVersion()
```
  - getJavaVendor
```
@Nullable
public static String getJavaVendor()
```
  - getJavaVendorURL
```
@Nullable
public static String getJavaVendorURL()
```
  - getJavaHome
```
@Nullable
public static String getJavaHome()
```
  - getJavaClassVersion
```
@Nullable
public static String getJavaClassVersion()
```
  - getJavaClassPath
```
@Nullable
public static String getJavaClassPath()
```
  - getJavaLibraryPath
```
@Nullable
public static String getJavaLibraryPath()
```
  - getOsName
```
@Nullable
public static String getOsName()
```
  - getOsArch
```
@Nullable
public static String getOsArch()
```
  - getOsVersion
```
@Nullable
public static String getOsVersion()
```
  - getFileSeparator
```
@Nullable
public static String getFileSeparator()
```
  - getPathSeparator
```
@Nullable
public static String getPathSeparator()
```
  - getLineSeparator
```
@Nullable
public static String getLineSeparator()
```
  - getUserName
```
@Nullable
public static String getUserName()
```
  - getUserHome
```
@Nullable
public static String getUserHome()
```
  - getUserDir
```
@Nullable
public static String getUserDir()
```
  - getJavaVmSpecificationVersion
```
@Nullable
public static String getJavaVmSpecificationVersion()
```
  - getJavaVmSpecificationVendor
```
@Nullable
public static String getJavaVmSpecificationVendor()
```
  - getJavaVmSpecificationUrl
```
@Nullable
public static String getJavaVmSpecificationUrl()
```
  - getJavaVmVersion
```
@Nullable
public static String getJavaVmVersion()
```
  - getJavaVmVendor
```
@Nullable
public static String getJavaVmVendor()
```
  - getJavaVmUrl
```
@Nullable
public static String getJavaVmUrl()
```
  - getJavaSpecificationVersion
```
@Nullable
public static String getJavaSpecificationVersion()
```
  - getJavaSpecificationVendor
```
@Nullable
public static String getJavaSpecificationVendor()
```
  - getJavaSpecificationUrl
```
@Nullable
public static String getJavaSpecificationUrl()
```
  - getTmpDir
```
@DevelopersNote(value="This property is not part of the language but part of the Sun SDK")
@Nullable
public static String getTmpDir()
```
  - getAllPropertyNames
```
@Nonnull
@ReturnsMutableCopy
public static Set<String> getAllPropertyNames()
```
    Returns:
    A set with all defined property names. Never null.
  - getAllProperties
```
@Nonnull
@ReturnsMutableCopy
public static Map<String,String> getAllProperties()
```
    Returns:
    A map with all system properties where the key is the system property name and the value is the system property value.
  - containsPropertyName
```
public static boolean containsPropertyName(String sPropertyName)
```
    Check if a system property with the given name exists.
    
    Parameters:
    sPropertyName - The name of the property.
    
    Returns:
    true if such a system property is present, false otherwise
  - setXMLEntityExpansionLimit
```
public static void setXMLEntityExpansionLimit(int nEntityExpansionLimit)
```
    Limit the number of entity expansions.
    
    Parameters:
    nEntityExpansionLimit - A positive integer. Values ≥ 0 are treated as no limit.
  - getXMLEntityExpansionLimit
```
public static int getXMLEntityExpansionLimit()
```
  - setXMLElementAttributeLimit
```
public static void setXMLElementAttributeLimit(int nElementAttributeLimit)
```
    Limit the number of attributes an element can have
    
    Parameters:
    nElementAttributeLimit - A positive integer. Values ≥ 0 are treated as no limit.
  - getXMLElementAttributeLimit
```
public static int getXMLElementAttributeLimit()
```
  - setXMLMaxOccur
```
public static void setXMLMaxOccur(int nMaxOccur)
```
    Limit the number of contentmodel nodes that may be created when building a grammar for a W3C XML Schema that contains maxOccurs attributes with values other than "unbounded".
    
    Parameters:
    nMaxOccur - A positive integer. Values ≥ 0 are treated as no limit.
  - getXMLMaxOccur
```
public static int getXMLMaxOccur()
```
  - setXMLTotalEntitySizeLimit
```
public static void setXMLTotalEntitySizeLimit(int nTotalEntitySizeLimit)
```
    Limit the total size of all entities that include general and parameter entities. The size is calculated as an aggregation of all entities.
    This is available since JDK 1.7.0_45/1.8
    
    Parameters:
    nTotalEntitySizeLimit - A positive integer. Values ≥ 0 are treated as no limit.
  - getXMLTotalEntitySizeLimit
```
public static int getXMLTotalEntitySizeLimit()
```
  - setXMLMaxGeneralEntitySizeLimit
```
public static void setXMLMaxGeneralEntitySizeLimit(int nMaxGeneralEntitySizeLimit)
```
    Limit the maximum size of any general entities. It is recommended that users set the limit to the smallest possible number so that malformed xml files can be caught quickly.
    This is available since JDK 1.7.0_45/1.8
    
    Parameters:
    nMaxGeneralEntitySizeLimit - A positive integer. Values ≥ 0 are treated as no limit.
  - getXMLMaxGeneralEntitySizeLimit
```
public static int getXMLMaxGeneralEntitySizeLimit()
```
  - setXMLMaxParameterEntitySizeLimit
```
public static void setXMLMaxParameterEntitySizeLimit(int nMaxParameterEntitySizeLimit)
```
    Limit the maximum size of any parameter entities, including the result of nesting multiple parameter entities. It is recommended that users set the limit to the smallest possible number so that malformed xml files can be caught quickly.
    This is available since JDK 1.7.0_45/1.8
    
    Parameters:
    nMaxParameterEntitySizeLimit - A positive integer. Values ≥ 0 are treated as no limit.
  - getXMLMaxParameterEntitySizeLimit
```
public static int getXMLMaxParameterEntitySizeLimit()
```

Class SystemProperties

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getPropertyValueOrNull

getPropertyValue

setPropertyValue

removePropertyValue

getJavaVersion

getJavaVendor

getJavaVendorURL

getJavaHome

getJavaClassVersion

getJavaClassPath

getJavaLibraryPath

getOsName

getOsArch

getOsVersion

getFileSeparator

getPathSeparator

getLineSeparator

getUserName

getUserHome

getUserDir

getJavaVmSpecificationVersion

getJavaVmSpecificationVendor

getJavaVmSpecificationUrl

getJavaVmVersion

getJavaVmVendor

getJavaVmUrl

getJavaSpecificationVersion

getJavaSpecificationVendor

getJavaSpecificationUrl

getTmpDir

getAllPropertyNames

getAllProperties

containsPropertyName

setXMLEntityExpansionLimit

getXMLEntityExpansionLimit

setXMLElementAttributeLimit

getXMLElementAttributeLimit

setXMLMaxOccur

getXMLMaxOccur

setXMLTotalEntitySizeLimit

getXMLTotalEntitySizeLimit

setXMLMaxGeneralEntitySizeLimit

getXMLMaxGeneralEntitySizeLimit

setXMLMaxParameterEntitySizeLimit

getXMLMaxParameterEntitySizeLimit