static/apidocs/org/apache/sis/metadata/ValueExistencePolicy.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
 <title>ValueExistencePolicy (Apache SIS 1.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2019-09-20">
 <meta name="keywords" content="org.apache.sis.metadata.ValueExistencePolicy class">
 <meta name="keywords" content="values()">
 <meta name="keywords" content="valueOf()">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="ValueExistencePolicy (Apache SIS 1.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":9,"i1":9};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 var pathtoroot = "../../../../";
 var useModuleDirectories = false;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/ValueExistencePolicy.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" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <ul class="navListSearch">
 <li><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.metadata</a></div>
 <h2 title="Enum ValueExistencePolicy" class="title">Enum ValueExistencePolicy</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li>
 <li>
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a>&gt;</li>
 <li>
 <ul class="inheritance">
 <li>ValueExistencePolicy</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a>&lt;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a>&gt;</code></dd>
 </dl>
 <hr>
 <pre>public enum <span class="typeNameLabel">ValueExistencePolicy</span>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a>&gt;</pre>
 <div class="block">Whatever <a href="MetadataStandard.html#asValueMap(java.lang.Object,java.lang.Class,org.apache.sis.metadata.KeyNamePolicy,org.apache.sis.metadata.ValueExistencePolicy)"><code>MetadataStandard.asValueMap(…)</code></a> shall contain entries for null,
  <a href="../xml/NilObject.html" title="interface in org.apache.sis.xml">nil</a> or empty values. By default the value map does not provide
  <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util" class="externalLink">entries</a> for <code>null</code> metadata properties, nil objects or
  <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#isEmpty()" title="class or interface in java.util" class="externalLink">empty collections</a>.
  This enumeration allows to control this behavior.

  <div class="section">Difference between null and nil</div>
  A null property is a reference which is <code>null</code> in the Java sense.
  Null references can be used for missing properties when no information is provided about why the property is missing.
  On the other hand, a nil object is a placeholder for a missing property similar in purpose to <code>null</code> references,
  except that an explanation about why the property is missing can be attached to those objects.
  Those explanations can be obtained by calls to the <a href="../xml/NilReason.html#forObject(java.lang.Object)"><code>NilReason.forObject(Object)</code></a> method.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.3</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="MetadataStandard.html#asValueMap(java.lang.Object,java.lang.Class,org.apache.sis.metadata.KeyNamePolicy,org.apache.sis.metadata.ValueExistencePolicy)"><code>MetadataStandard.asValueMap(Object, Class, KeyNamePolicy, ValueExistencePolicy)</code></a></dd>

 <p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="enum.constant.summary">
 <!--   -->
 </a>
 <h3>Enum Constant Summary</h3>
 <table class="memberSummary">
 <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Enum Constant</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ALL">ALL</a></span></code></th>
 <td class="colLast">
 <div class="block">Includes all entries in the map, including those having a null value or an empty collection.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#COMPACT">COMPACT</a></span></code></th>
 <td class="colLast">
 <div class="block">Includes non-empty properties but omits <a href="TitleProperty.html" title="annotation in org.apache.sis.metadata">title properties</a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#NON_EMPTY">NON_EMPTY</a></span></code></th>
 <td class="colLast">
 <div class="block">Includes only the properties that are non-null, non-nil and non empty.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#NON_NIL">NON_NIL</a></span></code></th>
 <td class="colLast">
 <div class="block">Includes only the non-null and non-nil properties.</div>
 </td>
 </tr>
 <tr class="altColor">
 <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#NON_NULL">NON_NULL</a></span></code></th>
 <td class="colLast">
 <div class="block">Includes only the non-null properties.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>static <a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
 <td class="colLast">
 <div class="block">Returns the enum constant of this type with the specified name.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>static <a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a>[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns an array containing the constants of this enum type, in
 the order they are declared.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.Enum">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang" class="externalLink">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang" class="externalLink">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang" class="externalLink">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang" class="externalLink">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="externalLink">valueOf</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ ENUM CONSTANT DETAIL =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="enum.constant.detail">
 <!--   -->
 </a>
 <h3>Enum Constant Detail</h3>
 <a id="ALL">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ALL</h4>
 <pre>public static final&nbsp;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a> ALL</pre>
 <div class="block">Includes all entries in the map, including those having a null value or an empty collection.</div>
 </li>
 </ul>
 <a id="NON_NULL">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>NON_NULL</h4>
 <pre>public static final&nbsp;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a> NON_NULL</pre>
 <div class="block">Includes only the non-null properties.
  <a href="../xml/NilObject.html" title="interface in org.apache.sis.xml"><code>NilObject</code></a>s are included.
  Collections are included no matter if they are empty or not.

  <p>The set of <code>NON_NULL</code> properties is a subset of <a href="#ALL"><code>ALL</code></a> properties.</p></div>
 </li>
 </ul>
 <a id="NON_NIL">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>NON_NIL</h4>
 <pre>public static final&nbsp;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a> NON_NIL</pre>
 <div class="block">Includes only the non-null and non-nil properties.
  Collections are included no matter if they are empty or not.

  <p>The set of <code>NON_NIL</code> properties is a subset of <a href="#NON_NULL"><code>NON_NULL</code></a> properties.</p></div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.4</dd>
 </dl>
 </li>
 </ul>
 <a id="NON_EMPTY">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>NON_EMPTY</h4>
 <pre>public static final&nbsp;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a> NON_EMPTY</pre>
 <div class="block">Includes only the properties that are non-null, non-nil and non empty.
  A non-null and non-nil property is considered empty in any of the following cases:

  <ul>
    <li>It is a character sequence containing only <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true#isWhitespace(int)" title="class or interface in java.lang" class="externalLink">whitespaces</a>.</li>
    <li>It is an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#isEmpty()" title="class or interface in java.util" class="externalLink">empty collection</a>.</li>
    <li>It is an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#isEmpty()" title="class or interface in java.util" class="externalLink">empty map</a>.</li>
    <li>It is an empty array (of length 0).</li>
  </ul>

  This is the default behavior of <a href="AbstractMetadata.html#asMap()"><code>AbstractMetadata.asMap()</code></a>.

  <p>The set of <code>NON_EMPTY</code> properties is a subset of <a href="#NON_NIL"><code>NON_NIL</code></a> properties.</p></div>
 </li>
 </ul>
 <a id="COMPACT">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>COMPACT</h4>
 <pre>public static final&nbsp;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a> COMPACT</pre>
 <div class="block">Includes non-empty properties but omits <a href="TitleProperty.html" title="annotation in org.apache.sis.metadata">title properties</a>.
  Values associated to title properties are instead associated with the parent node.
  This policy is relevant for metadata classes annotated with <a href="TitleProperty.html" title="annotation in org.apache.sis.metadata"><code>TitleProperty</code></a>;
  for all other classes, this policy is identical to <a href="#NON_EMPTY"><code>NON_EMPTY</code></a>.

  <div class="note"><b>Example:</b>
  the <a href="iso/citation/DefaultCitation.html" title="class in org.apache.sis.metadata.iso.citation"><code>DefaultCitation</code></a> and
  <a href="iso/citation/DefaultCitationDate.html" title="class in org.apache.sis.metadata.iso.citation"><code>DefaultCitationDate</code></a> classes are annotated with
  <code>&#64;TitleProperty(name="title")</code> and <code>&#64;TitleProperty(name="date")</code>
  respectively. The following table compares the trees produced by two policies:

  <table class="sis">
    <caption>Comparison of "non-empty" and "compact" policy on the same metadata</caption>
    <tr>
      <th><code>NON_EMPTY</code></th>
      <th class="sep"><code>COMPACT</code></th>
    </tr><tr><td>
      <blockquote><pre>Citation
  ├─Title……………………… My document
  └─Date
     ├─Date………………… 2012/01/01
     └─Date type…… Creation</pre></blockquote>
    </td><td class="sep">
      <blockquote><pre>Citation……………………… My document
  └─Date………………………… 2012/01/01
     └─Date type…… Creation</pre></blockquote>
    </td></tr>
  </table></div>

  This policy is the default behavior of <a href="AbstractMetadata.html#asTreeTable()"><code>AbstractMetadata.asTreeTable()</code></a>,
  and consequently defines the default rendering of <a href="AbstractMetadata.html#toString()"><code>AbstractMetadata.toString()</code></a>.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.8</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="TitleProperty.html" title="annotation in org.apache.sis.metadata"><code>TitleProperty</code></a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="values()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>values</h4>
 <pre class="methodSignature">public static&nbsp;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a>[]&nbsp;values()</pre>
 <div class="block">Returns an array containing the constants of this enum type, in
 the order they are declared. This method may be used to iterate
 over the constants as follows:
 <pre>
 for (ValueExistencePolicy c : ValueExistencePolicy.values())
 &nbsp;   System.out.println(c);
 </pre></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an array containing the constants of this enum type, in the order they are declared</dd>
 </dl>
 </li>
 </ul>
 <a id="valueOf(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>valueOf</h4>
 <pre class="methodSignature">public static&nbsp;<a href="ValueExistencePolicy.html" title="enum in org.apache.sis.metadata">ValueExistencePolicy</a>&nbsp;valueOf&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
 <div class="block">Returns the enum constant of this type with the specified name.
 The string must match <i>exactly</i> an identifier used to declare an
 enum constant in this type.  (Extraneous whitespace characters are
 not permitted.)</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>name</code> - the name of the enum constant to be returned.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the enum constant with the specified name</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the argument is null</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/ValueExistencePolicy.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" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.html">All&nbsp;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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>