| <!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 (1.8.0_252) on Fri Jul 16 09:38:48 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>EnumTypeConverter (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="EnumTypeConverter (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/mappings/converters/ConverterClass.html" title="class in org.eclipse.persistence.mappings.converters"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html" title="class in org.eclipse.persistence.mappings.converters"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/mappings/converters/EnumTypeConverter.html" target="_top">Frames</a></li> |
| <li><a href="EnumTypeConverter.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><a href="#fields.inherited.from.class.org.eclipse.persistence.mappings.converters.ObjectTypeConverter">Field</a> | </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.eclipse.persistence.mappings.converters</div> |
| <h2 title="Class EnumTypeConverter" class="title">Class EnumTypeConverter</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">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html" title="class in org.eclipse.persistence.mappings.converters">org.eclipse.persistence.mappings.converters.ObjectTypeConverter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.mappings.converters.EnumTypeConverter</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/eclipse/persistence/core/mappings/converters/CoreConverter.html" title="interface in org.eclipse.persistence.core.mappings.converters">CoreConverter</a><<a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a>,<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a>>, org.eclipse.persistence.internal.descriptors.ClassNameConversionRequired, <a href="../../../../../org/eclipse/persistence/mappings/converters/Converter.html" title="interface in org.eclipse.persistence.mappings.converters">Converter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">EnumTypeConverter</span> |
| extends <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html" title="class in org.eclipse.persistence.mappings.converters">ObjectTypeConverter</a></pre> |
| <div class="block"><b>Purpose</b>: Object type converter is used to match a fixed number of |
| database data values to a Java enum object value. It can be used when the |
| values on the database and in the Java differ. To create an object type |
| converter, simply specify the set of conversion value pairs. A default value |
| and one-way conversion are also supported for legacy data situations.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.eclipse.persistence.mappings.converters.EnumTypeConverter">Serialized Form</a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Guy Pelletier</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Toplink 10.1.4RI</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.mappings.converters.ObjectTypeConverter"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.persistence.mappings.converters.<a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html" title="class in org.eclipse.persistence.mappings.converters">ObjectTypeConverter</a></h3> |
| <code><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#addToAttributeOnlyConversionValueStrings">addToAttributeOnlyConversionValueStrings</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#attributeToFieldValues">attributeToFieldValues</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#conversionValueStrings">conversionValueStrings</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#converterName">converterName</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#dataType">dataType</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#dataTypeName">dataTypeName</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#defaultAttributeValue">defaultAttributeValue</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#defaultAttributeValueString">defaultAttributeValueString</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#fieldClassification">fieldClassification</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#fieldClassificationName">fieldClassificationName</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#fieldToAttributeValues">fieldToAttributeValues</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#mapping">mapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#objectType">objectType</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#objectTypeName">objectTypeName</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/converters/EnumTypeConverter.html#EnumTypeConverter-org.eclipse.persistence.mappings.DatabaseMapping-java.lang.Class-boolean-">EnumTypeConverter</a></span>(<a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> enumClass, |
| boolean useOrdinalValues)</code> |
| <div class="block">PUBLIC: |
| Creating an enum converter this way will create the conversion values |
| for you using ordinal or name values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/converters/EnumTypeConverter.html#EnumTypeConverter-org.eclipse.persistence.mappings.DatabaseMapping-java.lang.String-">EnumTypeConverter</a></span>(<a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> enumClassName)</code> |
| <div class="block">PUBLIC: |
| Creating an enum converter this way expects that you will provide |
| the conversion values separately.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/converters/EnumTypeConverter.html#EnumTypeConverter-org.eclipse.persistence.mappings.DatabaseMapping-java.lang.String-boolean-">EnumTypeConverter</a></span>(<a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> enumClassName, |
| boolean useOrdinalValues)</code> |
| <div class="block">PUBLIC: |
| Creating an enum converter this way will create the conversion values |
| for you using ordinal or name values.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/converters/EnumTypeConverter.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</code> |
| <div class="block">INTERNAL: |
| Convert all the class-name-based settings in this converter to actual |
| class-based settings.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/converters/EnumTypeConverter.html#convertDataValueToObjectValue-java.lang.Object-org.eclipse.persistence.sessions.Session-">convertDataValueToObjectValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> fieldValue, |
| <a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session)</code> |
| <div class="block">INTERNAL: |
| Returns the corresponding attribute value for the specified field value.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/converters/EnumTypeConverter.html#convertObjectValueToDataValue-java.lang.Object-org.eclipse.persistence.sessions.Session-">convertObjectValueToDataValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| <a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session)</code> |
| <div class="block">INTERNAL: |
| Convert Enum object to the data value.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/converters/EnumTypeConverter.html#getEnumClass--">getEnumClass</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/converters/EnumTypeConverter.html#getEnumClassName--">getEnumClassName</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/mappings/converters/EnumTypeConverter.html#initializeConversions-java.lang.Class-">initializeConversions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> enumClass)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.mappings.converters.ObjectTypeConverter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.persistence.mappings.converters.<a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html" title="class in org.eclipse.persistence.mappings.converters">ObjectTypeConverter</a></h3> |
| <code><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#addConversionValue-java.lang.Object-java.lang.Object-">addConversionValue</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#addConversionValueStrings-java.lang.String-java.lang.String-">addConversionValueStrings</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#addToAttributeOnlyConversionValue-java.lang.Object-java.lang.Object-">addToAttributeOnlyConversionValue</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#addToAttributeOnlyConversionValueStrings-java.lang.String-java.lang.String-">addToAttributeOnlyConversionValueStrings</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#getAttributeToFieldValues--">getAttributeToFieldValues</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#getDefaultAttributeValue--">getDefaultAttributeValue</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#getFieldClassification--">getFieldClassification</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#getFieldClassification-org.eclipse.persistence.internal.helper.DatabaseField-">getFieldClassification</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#getFieldClassificationName--">getFieldClassificationName</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#getFieldToAttributeValueAssociations--">getFieldToAttributeValueAssociations</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#getFieldToAttributeValues--">getFieldToAttributeValues</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#getMapping--">getMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#initialize-org.eclipse.persistence.mappings.DatabaseMapping-org.eclipse.persistence.sessions.Session-">initialize</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#initializeFieldClassification-org.eclipse.persistence.sessions.Session-">initializeFieldClassification</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#isMutable--">isMutable</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#loadClass-java.lang.String-java.lang.ClassLoader-">loadClass</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#mapBooleans--">mapBooleans</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#mapGenders--">mapGenders</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#mapResponses--">mapResponses</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setAttributeToFieldValues-java.util.Map-">setAttributeToFieldValues</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setConverterName-java.lang.String-">setConverterName</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setDataTypeName-java.lang.String-">setDataTypeName</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setDefaultAttributeValue-java.lang.Object-">setDefaultAttributeValue</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setDefaultAttributeValueString-java.lang.String-">setDefaultAttributeValueString</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setFieldClassification-java.lang.Class-">setFieldClassification</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setFieldClassificationName-java.lang.String-">setFieldClassificationName</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setFieldToAttributeValueAssociations-java.util.Vector-">setFieldToAttributeValueAssociations</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setFieldToAttributeValues-java.util.Map-">setFieldToAttributeValues</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setMapping-org.eclipse.persistence.mappings.DatabaseMapping-">setMapping</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#setObjectTypeName-java.lang.String-">setObjectTypeName</a>, <a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#throwInitObjectException-java.lang.Exception-java.lang.Class-java.lang.String-boolean-">throwInitObjectException</a></code></li> |
| </ul> |
| <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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <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">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</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">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">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</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">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">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">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="EnumTypeConverter-org.eclipse.persistence.mappings.DatabaseMapping-java.lang.Class-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EnumTypeConverter</h4> |
| <pre>public EnumTypeConverter(<a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> enumClass, |
| boolean useOrdinalValues)</pre> |
| <div class="block">PUBLIC: |
| Creating an enum converter this way will create the conversion values |
| for you using ordinal or name values.</div> |
| </li> |
| </ul> |
| <a name="EnumTypeConverter-org.eclipse.persistence.mappings.DatabaseMapping-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EnumTypeConverter</h4> |
| <pre>public EnumTypeConverter(<a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> enumClassName, |
| boolean useOrdinalValues)</pre> |
| <div class="block">PUBLIC: |
| Creating an enum converter this way will create the conversion values |
| for you using ordinal or name values.</div> |
| </li> |
| </ul> |
| <a name="EnumTypeConverter-org.eclipse.persistence.mappings.DatabaseMapping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EnumTypeConverter</h4> |
| <pre>public EnumTypeConverter(<a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> enumClassName)</pre> |
| <div class="block">PUBLIC: |
| Creating an enum converter this way expects that you will provide |
| the conversion values separately.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="initializeConversions-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initializeConversions</h4> |
| <pre>protected void initializeConversions(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> enumClass)</pre> |
| </li> |
| </ul> |
| <a name="getEnumClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnumClass</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> getEnumClass()</pre> |
| </li> |
| </ul> |
| <a name="getEnumClassName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnumClassName</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getEnumClassName()</pre> |
| </li> |
| </ul> |
| <a name="convertClassNamesToClasses-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertClassNamesToClasses</h4> |
| <pre>public void convertClassNamesToClasses(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</pre> |
| <div class="block">INTERNAL: |
| Convert all the class-name-based settings in this converter to actual |
| class-based settings. This method is used when converting a project |
| that has been built with class names to a project with classes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>convertClassNamesToClasses</code> in interface <code>org.eclipse.persistence.internal.descriptors.ClassNameConversionRequired</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></code> in class <code><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html" title="class in org.eclipse.persistence.mappings.converters">ObjectTypeConverter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classLoader</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="convertDataValueToObjectValue-java.lang.Object-org.eclipse.persistence.sessions.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertDataValueToObjectValue</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> convertDataValueToObjectValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> fieldValue, |
| <a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session)</pre> |
| <div class="block">INTERNAL: |
| Returns the corresponding attribute value for the specified field value. |
| Wraps the super method to return an Enum type from the string conversion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/core/mappings/converters/CoreConverter.html#convertDataValueToObjectValue-java.lang.Object-SESSION-">convertDataValueToObjectValue</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/core/mappings/converters/CoreConverter.html" title="interface in org.eclipse.persistence.core.mappings.converters">CoreConverter</a><<a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a>,<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/mappings/converters/Converter.html#convertDataValueToObjectValue-java.lang.Object-org.eclipse.persistence.sessions.Session-">convertDataValueToObjectValue</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/mappings/converters/Converter.html" title="interface in org.eclipse.persistence.mappings.converters">Converter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#convertDataValueToObjectValue-java.lang.Object-org.eclipse.persistence.sessions.Session-">convertDataValueToObjectValue</a></code> in class <code><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html" title="class in org.eclipse.persistence.mappings.converters">ObjectTypeConverter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="convertObjectValueToDataValue-java.lang.Object-org.eclipse.persistence.sessions.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>convertObjectValueToDataValue</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> convertObjectValueToDataValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| <a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session)</pre> |
| <div class="block">INTERNAL: |
| Convert Enum object to the data value. Internal enums are stored as |
| strings (names) so this method wraps the super method in that if |
| breaks down the enum to a string name before converting it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/core/mappings/converters/CoreConverter.html#convertObjectValueToDataValue-java.lang.Object-SESSION-">convertObjectValueToDataValue</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/core/mappings/converters/CoreConverter.html" title="interface in org.eclipse.persistence.core.mappings.converters">CoreConverter</a><<a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a>,<a href="../../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/mappings/converters/Converter.html#convertObjectValueToDataValue-java.lang.Object-org.eclipse.persistence.sessions.Session-">convertObjectValueToDataValue</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/mappings/converters/Converter.html" title="interface in org.eclipse.persistence.mappings.converters">Converter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html#convertObjectValueToDataValue-java.lang.Object-org.eclipse.persistence.sessions.Session-">convertObjectValueToDataValue</a></code> in class <code><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html" title="class in org.eclipse.persistence.mappings.converters">ObjectTypeConverter</a></code></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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/mappings/converters/ConverterClass.html" title="class in org.eclipse.persistence.mappings.converters"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/mappings/converters/ObjectTypeConverter.html" title="class in org.eclipse.persistence.mappings.converters"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/mappings/converters/EnumTypeConverter.html" target="_top">Frames</a></li> |
| <li><a href="EnumTypeConverter.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><a href="#fields.inherited.from.class.org.eclipse.persistence.mappings.converters.ObjectTypeConverter">Field</a> | </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>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
