| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Sun Feb 26 18:44:25 MST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PropertiesUtil (Apache Log4j API 2.8.1 API)</title> |
| <meta name="date" content="2017-02-26"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PropertiesUtil (Apache Log4j API 2.8.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PropertiesUtil.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/logging/log4j/util/PerformanceSensitive.html" title="annotation in org.apache.logging.log4j.util"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/logging/log4j/util/ProviderUtil.html" title="class in org.apache.logging.log4j.util"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/logging/log4j/util/PropertiesUtil.html" target="_top">Frames</a></li> |
| <li><a href="PropertiesUtil.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.logging.log4j.util</div> |
| <h2 title="Class PropertiesUtil" class="title">Class PropertiesUtil</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.util.PropertiesUtil</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.36">PropertiesUtil</a> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block"><em>Consider this class private.</em> |
| <p> |
| Helps access properties. This utility provides a method to override system properties by specifying properties in a |
| properties file. |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#PropertiesUtil(java.util.Properties)">PropertiesUtil</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</code> |
| <div class="block">Constructs a PropertiesUtil using a given Properties object as its source of defined properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#PropertiesUtil(java.lang.String)">PropertiesUtil</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertiesFileName)</code> |
| <div class="block">Constructs a PropertiesUtil for a given properties file name on the classpath.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#extractSubset(java.util.Properties,%20java.lang.String)">extractSubset</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</code> |
| <div class="block">Extracts properties that start with or are equals to the specific prefix and returns them in a new Properties |
| object with the prefix removed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getBooleanProperty(java.lang.String)">getBooleanProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Gets the named property as a boolean value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getBooleanProperty(java.lang.String,%20boolean)">getBooleanProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean defaultValue)</code> |
| <div class="block">Gets the named property as a boolean value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getCharsetProperty(java.lang.String)">getCharsetProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Gets the named property as a Charset value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getCharsetProperty(java.lang.String,%20java.nio.charset.Charset)">getCharsetProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> defaultValue)</code> |
| <div class="block">Gets the named property as a Charset value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getDoubleProperty(java.lang.String,%20double)">getDoubleProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| double defaultValue)</code> |
| <div class="block">Gets the named property as a double.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getIntegerProperty(java.lang.String,%20int)">getIntegerProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| int defaultValue)</code> |
| <div class="block">Gets the named property as an integer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getLongProperty(java.lang.String,%20long)">getLongProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| long defaultValue)</code> |
| <div class="block">Gets the named property as a long.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html" title="class in org.apache.logging.log4j.util">PropertiesUtil</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getProperties()">getProperties</a></strong>()</code> |
| <div class="block">Returns the PropertiesUtil used by Log4j.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getStringProperty(java.lang.String)">getStringProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Gets the named property as a String.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getStringProperty(java.lang.String,%20java.lang.String)">getStringProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</code> |
| <div class="block">Gets the named property as a String.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#getSystemProperties()">getSystemProperties</a></strong>()</code> |
| <div class="block">Return the system properties or an empty Properties object if an error occurs.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#isOsWindows()">isOsWindows</a></strong>()</code> |
| <div class="block">Returns true if system properties tell us we are running on Windows.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html#partitionOnCommonPrefixes(java.util.Properties)">partitionOnCommonPrefixes</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</code> |
| <div class="block">Partitions a properties map based on common key prefixes up to the first period.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PropertiesUtil(java.util.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PropertiesUtil</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.47">PropertiesUtil</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</pre> |
| <div class="block">Constructs a PropertiesUtil using a given Properties object as its source of defined properties.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - the Properties to use by default</dd></dl> |
| </li> |
| </ul> |
| <a name="PropertiesUtil(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PropertiesUtil</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.57">PropertiesUtil</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertiesFileName)</pre> |
| <div class="block">Constructs a PropertiesUtil for a given properties file name on the classpath. The properties specified in this |
| file are used by default. If a property is not defined in this file, then the equivalent system property is used.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertiesFileName</code> - the location of properties file to load</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre>public static <a href="../../../../../org/apache/logging/log4j/util/PropertiesUtil.html" title="class in org.apache.logging.log4j.util">PropertiesUtil</a> <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.99">getProperties</a>()</pre> |
| <div class="block">Returns the PropertiesUtil used by Log4j.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the main Log4j PropertiesUtil instance.</dd></dl> |
| </li> |
| </ul> |
| <a name="getBooleanProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBooleanProperty</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.111">getBooleanProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Gets the named property as a boolean value. If the property matches the string <code>"true"</code> (case-insensitive), |
| then it is returned as the boolean value <code>true</code>. Any other non-<code>null</code> text in the property is |
| considered <code>false</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to look up</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the boolean value of the property or <code>false</code> if undefined.</dd></dl> |
| </li> |
| </ul> |
| <a name="getBooleanProperty(java.lang.String, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBooleanProperty</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.122">getBooleanProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean defaultValue)</pre> |
| <div class="block">Gets the named property as a boolean value.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to look up</dd><dd><code>defaultValue</code> - the default value to use if the property is undefined</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the boolean value of the property or <code>defaultValue</code> if undefined.</dd></dl> |
| </li> |
| </ul> |
| <a name="getCharsetProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCharsetProperty</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.133">getCharsetProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Gets the named property as a Charset value.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to look up</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the Charset value of the property or <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true#defaultCharset()" title="class or interface in java.nio.charset"><code>Charset.defaultCharset()</code></a> if undefined.</dd></dl> |
| </li> |
| </ul> |
| <a name="getCharsetProperty(java.lang.String, java.nio.charset.Charset)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCharsetProperty</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.144">getCharsetProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> defaultValue)</pre> |
| <div class="block">Gets the named property as a Charset value.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to look up</dd><dd><code>defaultValue</code> - the default value to use if the property is undefined</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the Charset value of the property or <code>defaultValue</code> if undefined.</dd></dl> |
| </li> |
| </ul> |
| <a name="getDoubleProperty(java.lang.String, double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDoubleProperty</h4> |
| <pre>public double <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.156">getDoubleProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| double defaultValue)</pre> |
| <div class="block">Gets the named property as a double.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to look up</dd><dd><code>defaultValue</code> - the default value to use if the property is undefined</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the parsed double value of the property or <code>defaultValue</code> if it was undefined or could not be parsed.</dd></dl> |
| </li> |
| </ul> |
| <a name="getIntegerProperty(java.lang.String, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIntegerProperty</h4> |
| <pre>public int <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.176">getIntegerProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| int defaultValue)</pre> |
| <div class="block">Gets the named property as an integer.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to look up</dd><dd><code>defaultValue</code> - the default value to use if the property is undefined</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the parsed integer value of the property or <code>defaultValue</code> if it was undefined or could not be |
| parsed.</dd></dl> |
| </li> |
| </ul> |
| <a name="getLongProperty(java.lang.String, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLongProperty</h4> |
| <pre>public long <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.195">getLongProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| long defaultValue)</pre> |
| <div class="block">Gets the named property as a long.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to look up</dd><dd><code>defaultValue</code> - the default value to use if the property is undefined</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the parsed long value of the property or <code>defaultValue</code> if it was undefined or could not be parsed.</dd></dl> |
| </li> |
| </ul> |
| <a name="getStringProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStringProperty</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.213">getStringProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Gets the named property as a String.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to look up</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the String value of the property or <code>null</code> if undefined.</dd></dl> |
| </li> |
| </ul> |
| <a name="getStringProperty(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStringProperty</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.230">getStringProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</pre> |
| <div class="block">Gets the named property as a String.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to look up</dd><dd><code>defaultValue</code> - the default value to use if the property is undefined</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the String value of the property or <code>defaultValue</code> if undefined.</dd></dl> |
| </li> |
| </ul> |
| <a name="getSystemProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSystemProperties</h4> |
| <pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.240">getSystemProperties</a>()</pre> |
| <div class="block">Return the system properties or an empty Properties object if an error occurs.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The system properties.</dd></dl> |
| </li> |
| </ul> |
| <a name="extractSubset(java.util.Properties, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extractSubset</h4> |
| <pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.258">extractSubset</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</pre> |
| <div class="block">Extracts properties that start with or are equals to the specific prefix and returns them in a new Properties |
| object with the prefix removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - The Properties to evaluate.</dd><dd><code>prefix</code> - The prefix to extract.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The subset of properties.</dd></dl> |
| </li> |
| </ul> |
| <a name="partitionOnCommonPrefixes(java.util.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>partitionOnCommonPrefixes</h4> |
| <pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>> <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.290">partitionOnCommonPrefixes</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</pre> |
| <div class="block">Partitions a properties map based on common key prefixes up to the first period.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - properties to partition</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the partitioned properties where each key is the common prefix (minus the period) and the values are |
| new property maps without the prefix and period in the key</dd><dt><span class="strong">Since:</span></dt> |
| <dd>2.6</dd></dl> |
| </li> |
| </ul> |
| <a name="isOsWindows()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isOsWindows</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/logging/log4j/util/PropertiesUtil.html#line.306">isOsWindows</a>()</pre> |
| <div class="block">Returns true if system properties tell us we are running on Windows.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if system properties tell us we are running on Windows.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PropertiesUtil.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/logging/log4j/util/PerformanceSensitive.html" title="annotation in org.apache.logging.log4j.util"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/logging/log4j/util/ProviderUtil.html" title="class in org.apache.logging.log4j.util"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/logging/log4j/util/PropertiesUtil.html" target="_top">Frames</a></li> |
| <li><a href="PropertiesUtil.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 1999-2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |
