blob: 5aa8b413690b437a236b9b464ca7771b1e3ebac1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>PropertyNamingStrategy</title>
<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="PropertyNamingStrategy";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../jakarta/json/bind/config/BinaryDataStrategy.html" title="class in jakarta.json.bind.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/json/bind/config/PropertyOrderStrategy.html" title="class in jakarta.json.bind.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/json/bind/config/PropertyNamingStrategy.html" target="_top">Frames</a></li>
<li><a href="PropertyNamingStrategy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">jakarta.json.bind.config</div>
<h2 title="Interface PropertyNamingStrategy" class="title">Interface PropertyNamingStrategy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PropertyNamingStrategy</span></pre>
<div class="block"><p>Allows to define custom property naming strategy.
Specifies predefined property naming strategies.
Does not override JsonbProperty value.</p>
<p>This strategy can be set via <a href="../../../../jakarta/json/bind/JsonbConfig.html" title="class in jakarta.json.bind"><code>JsonbConfig</code></a>.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>JSON Binding 1.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../jakarta/json/bind/JsonbConfig.html" title="class in jakarta.json.bind"><code>JsonbConfig</code></a></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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/config/PropertyNamingStrategy.html#CASE_INSENSITIVE">CASE_INSENSITIVE</a></span></code>
<div class="block">Using this strategy, the serialization will be same as identity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/config/PropertyNamingStrategy.html#IDENTITY">IDENTITY</a></span></code>
<div class="block">Using this strategy, the property name is unchanged.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/config/PropertyNamingStrategy.html#LOWER_CASE_WITH_DASHES">LOWER_CASE_WITH_DASHES</a></span></code>
<div class="block">Using this strategy, the property name is transformed to lower case with dashes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/config/PropertyNamingStrategy.html#LOWER_CASE_WITH_UNDERSCORES">LOWER_CASE_WITH_UNDERSCORES</a></span></code>
<div class="block">Using this strategy, the property name is transformed to lower case with underscores.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/config/PropertyNamingStrategy.html#UPPER_CAMEL_CASE">UPPER_CAMEL_CASE</a></span></code>
<div class="block">Using this strategy, the first character will be capitalized.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/config/PropertyNamingStrategy.html#UPPER_CAMEL_CASE_WITH_SPACES">UPPER_CAMEL_CASE_WITH_SPACES</a></span></code>
<div class="block">Using this strategy, the first character will be capitalized and the words
will be separated by spaces.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/config/PropertyNamingStrategy.html#translateName-java.lang.String-">translateName</a></span>(java.lang.String&nbsp;propertyName)</code>
<div class="block">Translates the property name into its JSON field name representation.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="IDENTITY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IDENTITY</h4>
<pre>static final&nbsp;java.lang.String IDENTITY</pre>
<div class="block">Using this strategy, the property name is unchanged.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.json.bind.config.PropertyNamingStrategy.IDENTITY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LOWER_CASE_WITH_DASHES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOWER_CASE_WITH_DASHES</h4>
<pre>static final&nbsp;java.lang.String LOWER_CASE_WITH_DASHES</pre>
<div class="block">Using this strategy, the property name is transformed to lower case with dashes.
The dashes are on the positions of different case boundaries in the original field name (camel case).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.json.bind.config.PropertyNamingStrategy.LOWER_CASE_WITH_DASHES">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LOWER_CASE_WITH_UNDERSCORES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOWER_CASE_WITH_UNDERSCORES</h4>
<pre>static final&nbsp;java.lang.String LOWER_CASE_WITH_UNDERSCORES</pre>
<div class="block">Using this strategy, the property name is transformed to lower case with underscores.
The underscores are on the positions of different case boundaries in the original field name (camel case).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.json.bind.config.PropertyNamingStrategy.LOWER_CASE_WITH_UNDERSCORES">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="UPPER_CAMEL_CASE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UPPER_CAMEL_CASE</h4>
<pre>static final&nbsp;java.lang.String UPPER_CAMEL_CASE</pre>
<div class="block">Using this strategy, the first character will be capitalized.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.json.bind.config.PropertyNamingStrategy.UPPER_CAMEL_CASE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="UPPER_CAMEL_CASE_WITH_SPACES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UPPER_CAMEL_CASE_WITH_SPACES</h4>
<pre>static final&nbsp;java.lang.String UPPER_CAMEL_CASE_WITH_SPACES</pre>
<div class="block">Using this strategy, the first character will be capitalized and the words
will be separated by spaces.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.json.bind.config.PropertyNamingStrategy.UPPER_CAMEL_CASE_WITH_SPACES">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CASE_INSENSITIVE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CASE_INSENSITIVE</h4>
<pre>static final&nbsp;java.lang.String CASE_INSENSITIVE</pre>
<div class="block">Using this strategy, the serialization will be same as identity.
Deserialization will be case insensitive. E.g. property in JSON with name
PropertyNAME, will be mapped to field propertyName.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.json.bind.config.PropertyNamingStrategy.CASE_INSENSITIVE">Constant Field Values</a></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="translateName-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>translateName</h4>
<pre>java.lang.String&nbsp;translateName(java.lang.String&nbsp;propertyName)</pre>
<div class="block">Translates the property name into its JSON field name representation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propertyName</code> - Name of the property to translate.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Translated JSON field name.</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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../jakarta/json/bind/config/BinaryDataStrategy.html" title="class in jakarta.json.bind.config"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/json/bind/config/PropertyOrderStrategy.html" title="class in jakarta.json.bind.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/json/bind/config/PropertyNamingStrategy.html" target="_top">Frames</a></li>
<li><a href="PropertyNamingStrategy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>