org.carrot2.util.attribute

Class AttributeInfo

java.lang.Object

org.carrot2.util.attribute.AttributeInfo

public final class AttributeInfo
extends Object

Description of an Attribute of a Bindable type, including javadoc documentation and compile-time extracted tags.

Field Summary

Fields

Modifier and Type	Field and Description
String	className Name of the declaring class.
String	description Attribute description (javadoc excerpt).
String	fieldName Name of the declaring field.
String	group Attribute group in the user interface.
String	javaDoc Complete JavaDoc.
String	key Attribute key.
String	label Attribute label.
AttributeLevel	level Attribute level in the user interface.
String	title Attribute title.

Constructor Summary

Constructors

Constructor and Description
AttributeInfo(String key, String className, String fieldName, String javaDoc, String label, String title, String description, String group, AttributeLevel level, AttributeInfo inheritFrom)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

key

public final String key

Attribute key.

fieldName

public final String fieldName

Name of the declaring field.

className

public final String className

Name of the declaring class.

javaDoc

public final String javaDoc

Complete JavaDoc.

label

public final String label

Attribute label.

title

public final String title

Attribute title.

description

public final String description

Attribute description (javadoc excerpt).

group

public final String group

Attribute group in the user interface.

level

public final AttributeLevel level

Attribute level in the user interface.

Constructor Detail

AttributeInfo

public AttributeInfo(String key,
             String className,
             String fieldName,
             String javaDoc,
             String label,
             String title,
             String description,
             String group,
             AttributeLevel level,
             AttributeInfo inheritFrom)