Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-api / xref / org / apache / logging / log4j / message / StructuredDataId.html
blob: ad0126884b41df8541e6ca287d7c3f15cac74e05 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>StructuredDataId xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/logging/log4j/message/StructuredDataId.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.message;
<a class="jxr_linenumber" name="18" href="#18">18</a>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * The StructuredData identifier.</em>
<a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a> <strong class="jxr_keyword">implements</strong> Serializable {
<a class="jxr_linenumber" name="25" href="#25">25</a>
<a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * RFC 5424 Time Quality.</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a> TIME_QUALITY = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a>(<span class="jxr_string">"timeQuality"</span>, <strong class="jxr_keyword">null</strong>,
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">new</strong> String[]{<span class="jxr_string">"tzKnown"</span>, <span class="jxr_string">"isSynced"</span>, <span class="jxr_string">"syncAccuracy"</span>});
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * RFC 5424 Origin.</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a> ORIGIN = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a>(<span class="jxr_string">"origin"</span>, <strong class="jxr_keyword">null</strong>,
<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">new</strong> String[]{<span class="jxr_string">"ip"</span>, <span class="jxr_string">"enterpriseId"</span>, <span class="jxr_string">"software"</span>, <span class="jxr_string">"swVersion"</span>});
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * RFC 5424 Meta.</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a> META = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a>(<span class="jxr_string">"meta"</span>, <strong class="jxr_keyword">null</strong>,
<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">new</strong> String[]{<span class="jxr_string">"sequenceId"</span>, <span class="jxr_string">"sysUpTime"</span>, <span class="jxr_string">"language"</span>});
<a class="jxr_linenumber" name="41" href="#41">41</a>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * Reserved enterprise number.</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> RESERVED = -1;
<a class="jxr_linenumber" name="46" href="#46">46</a>
<a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 9031746276396249990L;
<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MAX_LENGTH = 32;
<a class="jxr_linenumber" name="49" href="#49">49</a>
<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String name;
<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> enterpriseNumber;
<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String[] required;
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String[] optional;
<a class="jxr_linenumber" name="54" href="#54">54</a>
<a class="jxr_linenumber" name="55" href="#55">55</a>
<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a>(String name, String[] required, String[] optional) {
<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">int</strong> index = -1;
<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">if</strong> (name != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">if</strong> (name.length() &gt; MAX_LENGTH) {
<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Length of id exceeds maximum of 32 characters: "</span> + name);
<a class="jxr_linenumber" name="61" href="#61">61</a> }
<a class="jxr_linenumber" name="62" href="#62">62</a> index = name.indexOf(<span class="jxr_string">"@"</span>);
<a class="jxr_linenumber" name="63" href="#63">63</a> }
<a class="jxr_linenumber" name="64" href="#64">64</a>
<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">if</strong> (index &gt; 0) {
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">this</strong>.name = name.substring(0, index);
<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">this</strong>.enterpriseNumber = Integer.parseInt(name.substring(index + 1));
<a class="jxr_linenumber" name="68" href="#68">68</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">this</strong>.enterpriseNumber = RESERVED;
<a class="jxr_linenumber" name="71" href="#71">71</a> }
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">this</strong>.required = required;
<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">this</strong>.optional = optional;
<a class="jxr_linenumber" name="74" href="#74">74</a> }
<a class="jxr_linenumber" name="75" href="#75">75</a>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * A Constructor that helps conformance to RFC 5424.</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @param name The name portion of the id.</em>
<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @param enterpriseNumber The enterprise number.</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @param required The list of keys that are required for this id.</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param optional The list of keys that are optional for this id.</em>
<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a>(String name, <strong class="jxr_keyword">int</strong> enterpriseNumber, String[] required, String[] optional) {
<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"No structured id name was supplied"</span>);
<a class="jxr_linenumber" name="87" href="#87">87</a> }
<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">if</strong> (name.contains(<span class="jxr_string">"@"</span>)) {
<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Structured id name cannot contain an '@"</span>);
<a class="jxr_linenumber" name="90" href="#90">90</a> }
<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">if</strong> (enterpriseNumber &lt;= 0) {
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"No enterprise number was supplied"</span>);
<a class="jxr_linenumber" name="93" href="#93">93</a> }
<a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">this</strong>.enterpriseNumber = enterpriseNumber;
<a class="jxr_linenumber" name="96" href="#96">96</a> String id = enterpriseNumber &lt; 0 ? name : name + <span class="jxr_string">"@"</span> + enterpriseNumber;
<a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">if</strong> (id.length() &gt; MAX_LENGTH) {
<a class="jxr_linenumber" name="98" href="#98">98</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Length of id exceeds maximum of 32 characters: "</span> + id);
<a class="jxr_linenumber" name="99" href="#99">99</a> }
<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">this</strong>.required = required;
<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">this</strong>.optional = optional;
<a class="jxr_linenumber" name="102" href="#102">102</a> }
<a class="jxr_linenumber" name="103" href="#103">103</a>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * Creates an id using another id to supply default values.</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @param id The original StructuredDataId.</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * @return the new StructuredDataId.</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a> makeId(<a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a> id) {
<a class="jxr_linenumber" name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (id == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="112" href="#112">112</a> }
<a class="jxr_linenumber" name="113" href="#113">113</a> <strong class="jxr_keyword">return</strong> makeId(id.getName(), id.getEnterpriseNumber());
<a class="jxr_linenumber" name="114" href="#114">114</a> }
<a class="jxr_linenumber" name="115" href="#115">115</a>
<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * Creates an id based on the current id.</em>
<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @param defaultId The default id to use if this StructuredDataId doesn't have a name.</em>
<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param enterpriseNumber The enterprise number.</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @return a StructuredDataId.</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a> makeId(String defaultId, <strong class="jxr_keyword">int</strong> enterpriseNumber) {
<a class="jxr_linenumber" name="123" href="#123">123</a> String id;
<a class="jxr_linenumber" name="124" href="#124">124</a> String[] req;
<a class="jxr_linenumber" name="125" href="#125">125</a> String[] opt;
<a class="jxr_linenumber" name="126" href="#126">126</a> <strong class="jxr_keyword">if</strong> (enterpriseNumber &lt;= 0) {
<a class="jxr_linenumber" name="127" href="#127">127</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="128" href="#128">128</a> }
<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.name != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="130" href="#130">130</a> id = <strong class="jxr_keyword">this</strong>.name;
<a class="jxr_linenumber" name="131" href="#131">131</a> req = <strong class="jxr_keyword">this</strong>.required;
<a class="jxr_linenumber" name="132" href="#132">132</a> opt = <strong class="jxr_keyword">this</strong>.optional;
<a class="jxr_linenumber" name="133" href="#133">133</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="134" href="#134">134</a> id = defaultId;
<a class="jxr_linenumber" name="135" href="#135">135</a> req = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="136" href="#136">136</a> opt = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="137" href="#137">137</a> }
<a class="jxr_linenumber" name="138" href="#138">138</a>
<a class="jxr_linenumber" name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/logging/log4j/message/StructuredDataId.html">StructuredDataId</a>(id, enterpriseNumber, req, opt);
<a class="jxr_linenumber" name="140" href="#140">140</a> }
<a class="jxr_linenumber" name="141" href="#141">141</a>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Returns a list of required keys.</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @return a List of required keys or null if none have been provided.</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">public</strong> String[] getRequired() {
<a class="jxr_linenumber" name="147" href="#147">147</a> <strong class="jxr_keyword">return</strong> required;
<a class="jxr_linenumber" name="148" href="#148">148</a> }
<a class="jxr_linenumber" name="149" href="#149">149</a>
<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * Returns a list of optional keys.</em>
<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * @return a List of optional keys or null if none have been provided.</em>
<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="154" href="#154">154</a> <strong class="jxr_keyword">public</strong> String[] getOptional() {
<a class="jxr_linenumber" name="155" href="#155">155</a> <strong class="jxr_keyword">return</strong> optional;
<a class="jxr_linenumber" name="156" href="#156">156</a> }
<a class="jxr_linenumber" name="157" href="#157">157</a>
<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * Return the StructuredDataId name.</em>
<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @return the StructuredDataId name.</em>
<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="162" href="#162">162</a> <strong class="jxr_keyword">public</strong> String getName() {
<a class="jxr_linenumber" name="163" href="#163">163</a> <strong class="jxr_keyword">return</strong> name;
<a class="jxr_linenumber" name="164" href="#164">164</a> }
<a class="jxr_linenumber" name="165" href="#165">165</a>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * Return the enterprise number.</em>
<a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @return the enterprise number.</em>
<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="170" href="#170">170</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getEnterpriseNumber() {
<a class="jxr_linenumber" name="171" href="#171">171</a> <strong class="jxr_keyword">return</strong> enterpriseNumber;
<a class="jxr_linenumber" name="172" href="#172">172</a> }
<a class="jxr_linenumber" name="173" href="#173">173</a>
<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * Indicates if the id is reserved.</em>
<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * @return true if the id uses the reserved enterprise number, false otherwise.</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="178" href="#178">178</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isReserved() {
<a class="jxr_linenumber" name="179" href="#179">179</a> <strong class="jxr_keyword">return</strong> enterpriseNumber &lt;= 0;
<a class="jxr_linenumber" name="180" href="#180">180</a> }
<a class="jxr_linenumber" name="181" href="#181">181</a>
<a class="jxr_linenumber" name="182" href="#182">182</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="183" href="#183">183</a> <strong class="jxr_keyword">return</strong> isReserved() ? name : name + <span class="jxr_string">"@"</span> + enterpriseNumber;
<a class="jxr_linenumber" name="184" href="#184">184</a> }
<a class="jxr_linenumber" name="185" href="#185">185</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>