schemacrawler.schema

Interface AttributedObject

All Known Subinterfaces:

BaseColumn<D>, Catalog, Column, ColumnDataType, DatabaseObject, DatabaseUser, DependantObject<P>, ForeignKey, Function, FunctionParameter, Index, IndexColumn, PartialDatabaseObject, PrimaryKey, Privilege<D>, Procedure, ProcedureParameter, ResultsColumn, Routine, RoutineParameter<R>, Schema, Sequence, Synonym, Table, TableConstraint, TableConstraintColumn, TableReference, Trigger, View, WeakAssociation

All Known Implementing Classes:

SchemaReference

public interface AttributedObject

Allow attributes on objects.

Method Summary

Modifier and Type	Method and Description
<T> T	getAttribute(String name) Gets an attribute.
<T> T	getAttribute(String name, T defaultValue) Gets an attribute.
Map<String,Object>	getAttributes() Gets all attributes.
boolean	hasAttribute(String name) Checks is an attribute is available.
<T> Optional<T>	lookupAttribute(String name) Gets an attribute.
void	removeAttribute(String name) Removes an attribute.
<T> void	setAttribute(String name, T value) Sets an attribute.

Method Detail

getAttribute

<T> T getAttribute(String name)

Gets an attribute.

Parameters:

name - Attribute name.

Returns:

Attribute value.

getAttribute

<T> T getAttribute(String name,
                   T defaultValue)
            throws ClassCastException

Gets an attribute.

Parameters:

name - Attribute name.

Returns:

Attribute value.

Throws:

ClassCastException - If the attribute class is not assignable from the the default value class.

getAttributes

Map<String,Object> getAttributes()

Gets all attributes.

Returns:

Map of attributes

hasAttribute

boolean hasAttribute(String name)

Checks is an attribute is available.

Parameters:

name - Attribute name.

Returns:

If attribute is available.

lookupAttribute

<T> Optional<T> lookupAttribute(String name)

Gets an attribute.

Parameters:

name - Attribute name.

Returns:

Attribute value.

removeAttribute

void removeAttribute(String name)

Removes an attribute.

Parameters:

name - Attribute name

setAttribute

<T> void setAttribute(String name,
                      T value)

Sets an attribute.

Parameters:

name - Attribute name

value - Attribute value