Top Description Fields Constructors Methods
org.yaml.snakeyaml.introspector

public abstract Class Property

extends Object
implements Comparable<Property>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Known Direct Subclasses
org.yaml.snakeyaml.introspector.PropertySubstitute, org.yaml.snakeyaml.introspector.GenericProperty, org.yaml.snakeyaml.introspector.MissingProperty
Imports
java.lang.annotation.Annotation, java.util.List

A Property represents a single member variable of a class, possibly including its accessor methods (getX, setX). The name stored in this class is the actual name of the property as given for the class, not an alias.

Objects of this class have a total ordering which defaults to ordering based on the name of the property.

Field Summary

Modifier and TypeField and Description
private final String
name

private final Class<?>
type

Constructor Summary

AccessConstructor and Description
public
Property(String name, Class<?> type)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(Property
the object to be compared.
o)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public boolean
equals(Object
the reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public abstract Object
get(Object object)

public abstract Class<?>[]
getActualTypeArguments()

public abstract <
class of the annotation
A extends Annotation> A

Returns:

property's annotation for the given type or null if it's not present
getAnnotation(Class<A>
the type of the annotation to be returned
annotationType)

Returns property's annotation for the given type or null if it's not present.

public abstract List<Annotation>

Returns:

the annotations that are present on this property or empty List if there're no annotations
getAnnotations()

Returns the annotations that are present on this property or empty List if there're no annotations.

public String
getName()

public Class<?>
getType()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
isReadable()

public boolean
isWritable()

public abstract void
set(Object object, Object value)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private final String name
typeback to summary
private final Class<?> type

Constructor Detail

Propertyback to summary
public Property(String name, Class<?> type)

Method Detail

compareToback to summary
public int compareTo(Property o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:Property

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getback to summary
public abstract Object get(Object object)
getActualTypeArgumentsback to summary
public abstract Class<?>[] getActualTypeArguments()
getAnnotationback to summary
public abstract <A extends Annotation> A getAnnotation(Class<A> annotationType)

Returns property's annotation for the given type or null if it's not present.

Parameters
<A>
class of the annotation
annotationType:Class<A>

the type of the annotation to be returned

Returns:A

property's annotation for the given type or null if it's not present

getAnnotationsback to summary
public abstract List<Annotation> getAnnotations()

Returns the annotations that are present on this property or empty List if there're no annotations.

Returns:List<Annotation>

the annotations that are present on this property or empty List if there're no annotations

getNameback to summary
public String getName()
getTypeback to summary
public Class<?> getType()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
isReadableback to summary
public boolean isReadable()
isWritableback to summary
public boolean isWritable()
setback to summary
public abstract void set(Object object, Object value) throws Exception
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override