Google Git
Sign in
apache / logging-log4j-audit-site / 4ea2ec6d7b4f743fb9c5b48c774e9fbe5be4cd24 / . / log4j-audit-1.0.0 / apidocs / org / apache / logging / log4j / catalog / api / Attribute.html
blob: f190e96614eef29077ce635938c60d0588c23121 [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>
<!-- Generated by javadoc (1.8.0_144) on Sun Jun 10 13:05:18 MST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Attribute (Apache Log4j Audit 1.0.0 API)</title>
<meta name="date" content="2018-06-10">
<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="Attribute (Apache Log4j Audit 1.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":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="class-use/Attribute.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/logging/log4j/catalog/api/CatalogData.html" title="class in org.apache.logging.log4j.catalog.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/catalog/api/Attribute.html" target="_top">Frames</a></li>
<li><a href="Attribute.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">org.apache.logging.log4j.catalog.api</div>
<h2 title="Class Attribute" class="title">Class Attribute</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://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>org.apache.logging.log4j.catalog.api.Attribute</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Attribute</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">A Catalog AttributeDto.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.logging.log4j.catalog.api.Attribute">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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/apache/logging/log4j/catalog/api/Attribute.html#Attribute--">Attribute</a></span>()</code>
<div class="block">Set default 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">&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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#getAliases--">getAliases</a></span>()</code>
<div class="block">Returns the List of alias Strings.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://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/apache/logging/log4j/catalog/api/Attribute.html#getCatalogId--">getCatalogId</a></span>()</code>
<div class="block">Get the Catalog Id this attribute is associated with.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Constraint.html" title="class in org.apache.logging.log4j.catalog.api">Constraint</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#getConstraints--">getConstraints</a></span>()</code>
<div class="block">Returns the constraints on this attribute.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/DataType.html" title="enum in org.apache.logging.log4j.catalog.api">DataType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#getDataType--">getDataType</a></span>()</code>
<div class="block">Returns the data type of this attribute.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://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/apache/logging/log4j/catalog/api/Attribute.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Returns the description of the attribute.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://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/apache/logging/log4j/catalog/api/Attribute.html#getDisplayName--">getDisplayName</a></span>()</code>
<div class="block">Returns the name used when displaying the attribute.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#getExamples--">getExamples</a></span>()</code>
<div class="block">Returns the List of example Strings.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#getId--">getId</a></span>()</code>
<div class="block">Return the attribute's id.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="http://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/apache/logging/log4j/catalog/api/Attribute.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of the AttributeDto.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#isIndexed--">isIndexed</a></span>()</code>
<div class="block">Identifies whether this attribute is an index.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#isRequestContext--">isRequestContext</a></span>()</code>
<div class="block">Returns whether this attribute is part of the RequestContext.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#isRequired--">isRequired</a></span>()</code>
<div class="block">Returns whether this attribute is required.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#isSortable--">isSortable</a></span>()</code>
<div class="block">Returns whether a sort may be performed on this attribute.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setAliases-java.util.Set-">setAliases</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;aliases)</code>
<div class="block">Sets List of alias Strings.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setCatalogId-java.lang.String-">setCatalogId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalogId)</code>
<div class="block">Set the catalog id this attribute is associated with.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setConstraints-java.util.Set-">setConstraints</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Constraint.html" title="class in org.apache.logging.log4j.catalog.api">Constraint</a>&gt;&nbsp;constraints)</code>
<div class="block">Sets the Constraints onf the attribute.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setDataType-org.apache.logging.log4j.catalog.api.DataType-">setDataType</a></span>(<a href="../../../../../../org/apache/logging/log4j/catalog/api/DataType.html" title="enum in org.apache.logging.log4j.catalog.api">DataType</a>&nbsp;dataType)</code>
<div class="block">Set the data type of the attribute.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setDescription-java.lang.String-">setDescription</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;description)</code>
<div class="block">Set the description of the attribute.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setDisplayName-java.lang.String-">setDisplayName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Set the name to be displayed for this attribute.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setExamples-java.util.Set-">setExamples</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;examples)</code>
<div class="block">Sets the List of example Strings.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setId-java.lang.Long-">setId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;id)</code>
<div class="block">Set the Attribute's id.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setIndexed-boolean-">setIndexed</a></span>(boolean&nbsp;indexed)</code>
<div class="block">Set whether this attribute is an index.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setName-java.lang.String-">setName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Set the name of the AttributeDto.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setRequestContext-boolean-">setRequestContext</a></span>(boolean&nbsp;isRequestContext)</code>
<div class="block">Set whether this attribute is part of the RequestContext.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setRequired-boolean-">setRequired</a></span>(boolean&nbsp;required)</code>
<div class="block">Set whether this attribute is required.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html#setSortable-boolean-">setSortable</a></span>(boolean&nbsp;sortable)</code>
<div class="block">Set whether a sort may be performed on this attribute.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="http://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/apache/logging/log4j/catalog/api/Attribute.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="Attribute--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Attribute</h4>
<pre>public&nbsp;Attribute()</pre>
<div class="block">Set default values.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;getId()</pre>
<div class="block">Return the attribute's id.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Attribute's id.</dd>
</dl>
</li>
</ul>
<a name="setId-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setId</h4>
<pre>public&nbsp;void&nbsp;setId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;id)</pre>
<div class="block">Set the Attribute's id.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the Attribute's id.</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Returns the name of the AttributeDto.</div>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setName(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Set the name of the AttributeDto.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="getDisplayName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDisplayName()</pre>
<div class="block">Returns the name used when displaying the attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the display name of the attribute.</dd>
</dl>
</li>
</ul>
<a name="setDisplayName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDisplayName</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setDisplayName(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Set the name to be displayed for this attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the display name for the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="getDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDescription()</pre>
<div class="block">Returns the description of the attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the description of the attribute.</dd>
</dl>
</li>
</ul>
<a name="setDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescription</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setDescription(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;description)</pre>
<div class="block">Set the description of the attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - the description of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="getDataType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataType</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/DataType.html" title="enum in org.apache.logging.log4j.catalog.api">DataType</a>&nbsp;getDataType()</pre>
<div class="block">Returns the data type of this attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the data type of the attribute.</dd>
</dl>
</li>
</ul>
<a name="setDataType-org.apache.logging.log4j.catalog.api.DataType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDataType</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setDataType(<a href="../../../../../../org/apache/logging/log4j/catalog/api/DataType.html" title="enum in org.apache.logging.log4j.catalog.api">DataType</a>&nbsp;dataType)</pre>
<div class="block">Set the data type of the attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataType</code> - the data type of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="isIndexed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIndexed</h4>
<pre>public&nbsp;boolean&nbsp;isIndexed()</pre>
<div class="block">Identifies whether this attribute is an index.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this attribute is an index, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="setIndexed-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexed</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setIndexed(boolean&nbsp;indexed)</pre>
<div class="block">Set whether this attribute is an index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indexed</code> - true if this attribute is an index, false otherwise.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="isSortable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSortable</h4>
<pre>public&nbsp;boolean&nbsp;isSortable()</pre>
<div class="block">Returns whether a sort may be performed on this attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if a sort can be performed on this attribute, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="setSortable-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortable</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setSortable(boolean&nbsp;sortable)</pre>
<div class="block">Set whether a sort may be performed on this attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sortable</code> - true if a sort may be performed on this attribute, false otherwise.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="isRequired--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRequired</h4>
<pre>public&nbsp;boolean&nbsp;isRequired()</pre>
<div class="block">Returns whether this attribute is required.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this attribute is required, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="setRequired-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequired</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setRequired(boolean&nbsp;required)</pre>
<div class="block">Set whether this attribute is required.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>required</code> - true if this attribute is required, false otherwise.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="isRequestContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRequestContext</h4>
<pre>public&nbsp;boolean&nbsp;isRequestContext()</pre>
<div class="block">Returns whether this attribute is part of the RequestContext.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this attribute is part of the RequestContext, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="setRequestContext-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequestContext</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setRequestContext(boolean&nbsp;isRequestContext)</pre>
<div class="block">Set whether this attribute is part of the RequestContext.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>isRequestContext</code> - true if this attribute is part of the RequestContext, false otherwise.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="getExamples--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExamples</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getExamples()</pre>
<div class="block">Returns the List of example Strings.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the List of example Strings.</dd>
</dl>
</li>
</ul>
<a name="setExamples-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExamples</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setExamples(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;examples)</pre>
<div class="block">Sets the List of example Strings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>examples</code> - the List of example Strings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="getAliases--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAliases</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getAliases()</pre>
<div class="block">Returns the List of alias Strings.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the List of alias Strings.</dd>
</dl>
</li>
</ul>
<a name="setAliases-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAliases</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setAliases(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;aliases)</pre>
<div class="block">Sets List of alias Strings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>aliases</code> - The List of alias Strings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this Attribute.</dd>
</dl>
</li>
</ul>
<a name="getConstraints--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConstraints</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Constraint.html" title="class in org.apache.logging.log4j.catalog.api">Constraint</a>&gt;&nbsp;getConstraints()</pre>
<div class="block">Returns the constraints on this attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of constraints.</dd>
</dl>
</li>
</ul>
<a name="setConstraints-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConstraints</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Attribute.html" title="class in org.apache.logging.log4j.catalog.api">Attribute</a>&nbsp;setConstraints(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/logging/log4j/catalog/api/Constraint.html" title="class in org.apache.logging.log4j.catalog.api">Constraint</a>&gt;&nbsp;constraints)</pre>
<div class="block">Sets the Constraints onf the attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>constraints</code> - The List of constraints.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This Attribute.</dd>
</dl>
</li>
</ul>
<a name="getCatalogId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCatalogId</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCatalogId()</pre>
<div class="block">Get the Catalog Id this attribute is associated with.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the catalog id or null.</dd>
</dl>
</li>
</ul>
<a name="setCatalogId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCatalogId</h4>
<pre>public&nbsp;void&nbsp;setCatalogId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalogId)</pre>
<div class="block">Set the catalog id this attribute is associated with.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalogId</code> - The catalog id or null.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</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="class-use/Attribute.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/logging/log4j/catalog/api/CatalogData.html" title="class in org.apache.logging.log4j.catalog.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/catalog/api/Attribute.html" target="_top">Frames</a></li>
<li><a href="Attribute.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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><p align="center">Copyright &#169; 2016-2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Apache Log4j Audit, Log4j, Log4j Audit, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p>
</body>
</html>