Module org.jooq

Package org.jooq

Interface Named

All Superinterfaces:

QueryPart, Serializable

All Known Subinterfaces:

AggregateFilterStep<T>, AggregateFunction<T>, ArrayAggOrderByStep<T>, CaseConditionStep<T>, CaseWhenStep<V,T>, Catalog, Check<R>, CommonTableExpression<R>, Constraint, ConstraintEnforcementStep, ConstraintFinalStep, ConstraintForeignKeyOnStep, ConstraintTypeStep, DataType<T>, Domain<T>, Field<T>, FieldOrConstraint, ForeignKey<R,O>, GroupConcatOrderByStep, GroupConcatSeparatorStep, Index, JSONArrayAggNullStep<T>, JSONArrayAggOrderByStep<J>, JSONArrayNullStep<T>, JSONObjectAggNullStep<T>, JSONObjectNullStep<T>, JSONTableColumnPathStep, JSONTableColumnsStep, JSONValueOnStep<J>, Key<R>, Label, Package, Param<T>, Parameter<T>, Period<T>, Qualified, Role, Routine<T>, Schema, SelectField<T>, Sequence<T>, Table<R>, TableField<R,T>, TableOnConditionStep<R>, TableOptionalOnStep<R>, UDT<R>, UDTField<R,T>, UniqueKey<R>, User, Variable<T>, WindowBeforeOverStep<T>, WindowExcludeStep<T>, WindowFinalStep<T>, WindowOrderByStep<T>, WindowPartitionByStep<T>, WindowRowsStep<T>, XMLAggOrderByStep<T>, XMLTableColumnPathStep, XMLTableColumnsStep

All Known Implementing Classes:

AbstractRoutine, CatalogImpl, CustomField, CustomTable, DefaultDataType, LazyCatalog, LazySchema, PackageImpl, SchemaImpl, SequenceImpl, TableImpl, UDTImpl

public interface Named
extends QueryPart

A common base type for all qualifiable, named objects.

Instances of this type cannot be created directly, only of its subtypes.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@NotNull String	getComment()	The comment on this object.
@NotNull Comment	getCommentPart()	The comment on this object as a QueryPart.
@NotNull String	getName()	The unqualified name of this object.
@NotNull Name	getQualifiedName()	The qualified name of this object.
@NotNull Name	getUnqualifiedName()	The unqualified name of this object.

Methods inherited from interface org.jooq.QueryPart

equals, hashCode, toString

Method Detail

getName

@NotNull
@NotNull String getName()

The unqualified name of this object.

getQualifiedName

@NotNull
@NotNull Name getQualifiedName()

The qualified name of this object.

getUnqualifiedName

@NotNull
@NotNull Name getUnqualifiedName()

The unqualified name of this object.

getComment

@NotNull
@NotNull String getComment()

The comment on this object.

This is the same as calling getCommentPart() and then Comment.getComment().

getCommentPart

@NotNull
@NotNull Comment getCommentPart()

The comment on this object as a QueryPart.