schemacrawler.schema

Interface AttributedObject

All Known Subinterfaces:

BaseColumn<D>, Catalog, Column, ColumnDataType, DatabaseObject, DependantObject<P>, ForeignKey, Function, FunctionColumn, Index, IndexColumn, PartialDatabaseObject, PrimaryKey, Privilege<D>, Procedure, ProcedureColumn, ResultsColumn, Routine, RoutineColumn<R>, Schema, Sequence, Synonym, Table, TableConstraint, TableConstraintColumn, Trigger, View

All Known Implementing Classes:

BaseCatalogDecorator, SchemaReference

public interface AttributedObject

Allow attributes on objects.

Author:

Sualeh Fatehi

Method Summary

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

Method Detail

getAttribute

<T> T getAttribute(java.lang.String name)

Gets an attribute.

Parameters:

name - Attribute name.

Returns:

Attribute value.

getAttribute

<T> T getAttribute(java.lang.String name,
                   T defaultValue)

Gets an attribute.

Parameters:

name - Attribute name.

Returns:

Attribute value.

getAttributes

java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Gets all attributes.

Returns:

Map of attributes

hasAttribute

boolean hasAttribute(java.lang.String name)

Checks is an attribute is available.

Parameters:

name - Attribute name.

Returns:

If attribute is available.

lookupAttribute

<T> java.util.Optional<T> lookupAttribute(java.lang.String name)

Gets an attribute.

Parameters:

name - Attribute name.

Returns:

Attribute value.

removeAttribute

void removeAttribute(java.lang.String name)

Removes an attribute.

Parameters:

name - Attribute name

setAttribute

<T> void setAttribute(java.lang.String name,
                      T value)

Sets an attribute.

Parameters:

name - Attribute name

value - Attribute value