Google Git
Sign in
apache / tomee-site-pub / 294f8729efbe13f29a64f7a60a72b67641434a45 / . / tomee-8.0 / javadoc / javax / xml / registry / infomodel / InternationalString.html
blob: 0e88e3a4d2442f452446315b71f94953b1428e54 [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>InternationalString</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="InternationalString";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":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="../../../../javax/xml/registry/infomodel/ExtrinsicObject.html" title="interface in javax.xml.registry.infomodel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/xml/registry/infomodel/Key.html" title="interface in javax.xml.registry.infomodel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/xml/registry/infomodel/InternationalString.html" target="_top">Frames</a></li>
<li><a href="InternationalString.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>Field&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>Field&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">javax.xml.registry.infomodel</div>
<h2 title="Interface InternationalString" class="title">Interface InternationalString</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">InternationalString</span></pre>
<div class="block">This interface represents a String that has been internationalized into several Locales.
This interface is used as a replacement for the String type whenever a String attribute needs to be I18N capable. An instance of the InternationalString interface composes within it a Collection of LocalizedString instances, where each String is specific to a particular Locale. The InternationalString interface provides set/get methods for adding or getting locale specific String values for the InternationalString instance.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/xml/registry/infomodel/LocalizedString.html" title="interface in javax.xml.registry.infomodel"><code>LocalizedString</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#addLocalizedString-javax.xml.registry.infomodel.LocalizedString-">addLocalizedString</a></span>(<a href="../../../../javax/xml/registry/infomodel/LocalizedString.html" title="interface in javax.xml.registry.infomodel">LocalizedString</a>&nbsp;localizedString)</code>
<div class="block">Adds a LocalizedString to this object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#addLocalizedStrings-java.util.Collection-">addLocalizedStrings</a></span>(java.util.Collection&nbsp;localizedStrings)</code>
<div class="block">Adds many LocalizedStrings to this object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/xml/registry/infomodel/LocalizedString.html" title="interface in javax.xml.registry.infomodel">LocalizedString</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#getLocalizedString-java.util.Locale-java.lang.String-">getLocalizedString</a></span>(java.util.Locale&nbsp;locale,
java.lang.String&nbsp;charsetName)</code>
<div class="block">Gets the LocalizedString for the specified Locale and charsetName.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Collection</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#getLocalizedStrings--">getLocalizedStrings</a></span>()</code>
<div class="block">Returns the LocalizedStrings associated with this object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#getValue--">getValue</a></span>()</code>
<div class="block">Gets the String value for the Locale returned by Locale.getDefault().</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#getValue-java.util.Locale-">getValue</a></span>(java.util.Locale&nbsp;locale)</code>
<div class="block">Gets the String value for the specified Locale.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#removeLocalizedString-javax.xml.registry.infomodel.LocalizedString-">removeLocalizedString</a></span>(<a href="../../../../javax/xml/registry/infomodel/LocalizedString.html" title="interface in javax.xml.registry.infomodel">LocalizedString</a>&nbsp;localizedString)</code>
<div class="block">Removes a LocalizedString from this object.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#removeLocalizedStrings-java.util.Collection-">removeLocalizedStrings</a></span>(java.util.Collection&nbsp;localizedStrings)</code>
<div class="block">Removes specified LocalizedStrings to this object.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#setValue-java.util.Locale-java.lang.String-">setValue</a></span>(java.util.Locale&nbsp;locale,
java.lang.String&nbsp;value)</code>
<div class="block">Sets the String value for the specified Locale.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/InternationalString.html#setValue-java.lang.String-">setValue</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Sets the String value for the Locale returned by Locale.getDefault().</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>java.lang.String&nbsp;getValue()
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Gets the String value for the Locale returned by Locale.getDefault().
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the String value for the Locale returned by Locale.getDefault()</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="getValue-java.util.Locale-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>java.lang.String&nbsp;getValue(java.util.Locale&nbsp;locale)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Gets the String value for the specified Locale. Return null if no locale specific
value is found for the specified locale.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locale</code> - The Locale for the desired value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the String value for the specified Locale</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="setValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>void&nbsp;setValue(java.lang.String&nbsp;value)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Sets the String value for the Locale returned by Locale.getDefault().
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the String value for the Locale returned by Locale.getDefault()</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="setValue-java.util.Locale-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>void&nbsp;setValue(java.util.Locale&nbsp;locale,
java.lang.String&nbsp;value)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Sets the String value for the specified Locale.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locale</code> - The locale for this value being set</dd>
<dd><code>value</code> - The value being set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="addLocalizedString-javax.xml.registry.infomodel.LocalizedString-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addLocalizedString</h4>
<pre>void&nbsp;addLocalizedString(<a href="../../../../javax/xml/registry/infomodel/LocalizedString.html" title="interface in javax.xml.registry.infomodel">LocalizedString</a>&nbsp;localizedString)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Adds a LocalizedString to this object.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>localizedString</code> - the LocalizedString being added to this object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="addLocalizedStrings-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addLocalizedStrings</h4>
<pre>void&nbsp;addLocalizedStrings(java.util.Collection&nbsp;localizedStrings)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Adds many LocalizedStrings to this object.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>localizedStrings</code> - the Collection of LocalizedStrings being added to this object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="removeLocalizedString-javax.xml.registry.infomodel.LocalizedString-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeLocalizedString</h4>
<pre>void&nbsp;removeLocalizedString(<a href="../../../../javax/xml/registry/infomodel/LocalizedString.html" title="interface in javax.xml.registry.infomodel">LocalizedString</a>&nbsp;localizedString)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Removes a LocalizedString from this object.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>localizedString</code> - the LocalizedString being removed from this object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="removeLocalizedStrings-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeLocalizedStrings</h4>
<pre>void&nbsp;removeLocalizedStrings(java.util.Collection&nbsp;localizedStrings)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Removes specified LocalizedStrings to this object.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>localizedStrings</code> - the Collection of LocalizedStrings being removed from this object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="getLocalizedString-java.util.Locale-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalizedString</h4>
<pre><a href="../../../../javax/xml/registry/infomodel/LocalizedString.html" title="interface in javax.xml.registry.infomodel">LocalizedString</a>&nbsp;getLocalizedString(java.util.Locale&nbsp;locale,
java.lang.String&nbsp;charsetName)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Gets the LocalizedString for the specified Locale and charsetName.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locale</code> - The loacle for the desired LocalizedStrings</dd>
<dd><code>charsetName</code> - The character set name for the desired LocalizedStrings</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the LocalizedString that matches specified locale and character set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="getLocalizedStrings--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLocalizedStrings</h4>
<pre>java.util.Collection&nbsp;getLocalizedStrings()
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Returns the LocalizedStrings associated with this object.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Collection of LocalizedString instances. The Collection may be empty but not null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/xml/registry/infomodel/LocalizedString.html" title="interface in javax.xml.registry.infomodel"><code>LocalizedString</code></a></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="../../../../javax/xml/registry/infomodel/ExtrinsicObject.html" title="interface in javax.xml.registry.infomodel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/xml/registry/infomodel/Key.html" title="interface in javax.xml.registry.infomodel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/xml/registry/infomodel/InternationalString.html" target="_top">Frames</a></li>
<li><a href="InternationalString.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>Field&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>Field&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>