Top Description Inners Fields Constructors Methods
liquibase

public Class ObjectMetaData

extends Object
Class Inheritance
Imports
liquibase.util.StringUtil, java.lang.reflect.Type, java.util.SortedSet, .TreeSet

Contains metadata about an ExtensibleObject.

Because attributes can be dynamically added or removed, different instances of the same type may return different metadata.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ObjectMetaData.Attribute

Metadata about a particular attribute.

Field Summary

Modifier and TypeField and Description
public SortedSet<ObjectMetaData.Attribute>
attributes

Metadata about all the object's attributes.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public ObjectMetaData.Attribute
getAttribute(String attributeName)

Convenience method to return the liquibase.ObjectMetaData.Attribute information for the given attribute.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attributesback to summary
public SortedSet<ObjectMetaData.Attribute> attributes

Metadata about all the object's attributes.

Constructor Detail

ObjectMetaDataback to summary
public ObjectMetaData()

Method Detail

getAttributeback to summary
public ObjectMetaData.Attribute getAttribute(String attributeName)

Convenience method to return the liquibase.ObjectMetaData.Attribute information for the given attribute. Returns null if the attribute name doesn't exist.

liquibase back to summary

public Class ObjectMetaData.Attribute

extends Object
implements Comparable<ObjectMetaData.Attribute>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable

Metadata about a particular attribute.

Field Summary

Modifier and TypeField and Description
public String
description

Description of the attribute.

public String
name

Name of the attribute.

public Boolean
required

True if the attribute is required.

public Type
type

Return the stored type of the given attribute.

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(ObjectMetaData.Attribute
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.
obj
)

Overrides java.lang.Object.equals.

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

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

descriptionback to summary
public String description

Description of the attribute.

nameback to summary
public String name

Name of the attribute.

requiredback to summary
public Boolean required

True if the attribute is required. What "required" means can depend on the type of object, but in general it should mean that the object is not "valid" if a value isn't set.

typeback to summary
public Type type

Return the stored type of the given attribute. Include any applicable generics information.

Constructor Detail

Attributeback to summary
public Attribute()
Attributeback to summary
public Attribute(String name)

Method Detail

compareToback to summary
public int compareTo(ObjectMetaData.Attribute 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:ObjectMetaData.Attribute

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.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

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
obj: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
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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