Top Description Fields Constructors Methods
org.jooq.impl

public abstract non-sealed Class CustomField<T>

extends AbstractField<T>
implements QOM.UEmptyField<T>, UOpaque
Class Inheritance
All Implemented Interfaces
org.jooq.impl.QOM.UOpaque, org.jooq.impl.QOM.UEmpty, org.jooq.QueryPart, java.io.Serializable, org.jooq.impl.QOM.UEmptyField, org.jooq.Field, org.jooq.TableElement, org.jooq.Named, org.jooq.FieldOrConstraint, org.jooq.FieldOrRowOrSelect, org.jooq.FieldOrRow, org.jooq.OrderField, org.jooq.GroupField, org.jooq.SelectField, org.jooq.Typed, org.jooq.SelectFieldOrAsterisk
Static Imports
org.jooq.Clause.CUSTOM

Deprecated

as a consequence of AbstractField and QOM.UEmptyField being deprecated. See corresponding docs for further information.

A base class for custom Field implementations in client code.

Client code may provide proper Condition implementations extending this useful base class. All necessary parts of the Condition interface are already implemented. Only this method needs further implementation: accept(Context).

Refer to that methods' Javadoc for further details about their expected behaviour.

Author
Lukas Eder

Field Summary

Modifier and TypeField and Description
private static final Clause[]
CLAUSES

Hides org.jooq.impl.AbstractField.CLAUSES.

Deprecated as a consequence of Clause being deprecated.

Constructor Summary

AccessConstructor and Description
protected
CustomField(String name, DataType<T> type)

protected
CustomField(Name name, DataType<T> type)

Method Summary

Modifier and TypeMethod and Description
public abstract void
accept(Context<?> ctx)

Redeclares org.jooq.QueryPartInternal.accept.

Implements abstract org.jooq.impl.AbstractField.accept.

Subclasses must implement this method.
public final Field<T>
as(Name
The alias name
alias)

Overrides org.jooq.impl.AbstractField.as.

Implements org.jooq.Field.as.

Deprecated as a consequence of Field being deprecated.
Create an alias for this field.
public final Clause[]
clauses(Context<?> ctx)

Overrides org.jooq.impl.AbstractField.clauses.

Implements org.jooq.QueryPartInternal.clauses.

Deprecated as a consequence of Clause being deprecated.
The Clauses that are represented by this query part.
public final boolean
declaresFields()

Overrides org.jooq.impl.AbstractQueryPart.declaresFields.

Implements org.jooq.QueryPartInternal.declaresFields.

Subclasses may override this
public final boolean
declaresTables()

Overrides org.jooq.impl.AbstractQueryPart.declaresTables.

Implements org.jooq.QueryPartInternal.declaresTables.

Subclasses may override this
public static final <T> CustomField<T>
of(String name, DataType<T> type, Consumer<? super Context<?>> consumer)

Deprecated as a consequence of CustomField being deprecated.
Create a CustomField from a lambda expression.
public static final <T> CustomField<T>
of(Name name, DataType<T> type, Consumer<? super Context<?>> consumer)

Deprecated as a consequence of CustomField being deprecated.
Create a CustomField from a lambda expression.
Inherited from org.jooq.impl.AbstractField:
$alias$aliasedabsacosaddaddasasasascasciiasinatanatan2atan2avgavgOverbetweenbetweenbetweenbetweenbetweenSymmetricbetweenSymmetricbetweenSymmetricbetweenSymmetricbitAndbitAndbitLengthbitNandbitNandbitNorbitNorbitNotbitOrbitOrbitXNorbitXNorbitXorbitXorcastcastcastceilchangedcharLengthcoalescecoalescecoercecoercecoercecollatecollatecollatecommentcommentcomparecomparecomparecompareconcatconcatconcatcontainscontainscontainsIgnoreCasecontainsIgnoreCaseconvertconvertconvertconvertFromconvertFromconvertToconvertTocoscoshcotcothcountcountDistinctcountOverdecodedecodedecodedecodedegdescdivdivdividedivideendsWithendsWithendsWithIgnoreCaseendsWithIgnoreCaseeqeqeqeqequalequalequalequalequalIgnoreCaseequalIgnoreCaseexpextractfieldfirstValuefloorfromgegegegegetgetValuegreaterOrEqualgreaterOrEqualgreaterOrEqualgreaterOrEqualgreaterThangreaterThangreaterThangreaterThangreatestgreatestgtgtgtgtinininininisDistinctFromisDistinctFromisDistinctFromisDocumentisFalseisJsonisNotDistinctFromisNotDistinctFromisNotDistinctFromisNotDocumentisNotJsonisNotNullisNullisNullableisPossiblyNullableisTruelaglaglaglaglastValueleleleleleadleadleadleadleastleastlengthlessOrEquallessOrEquallessOrEquallessOrEquallessThanlessThanlessThanlessThanlikelikelikelikelikelikeIgnoreCaselikeIgnoreCaselikeIgnoreCaselikeIgnoreCaselikeRegexlikeRegexlnloglowerlpadlpadlpadlpadltltltltltrimmaxmaxOvermedianminminOverminusminusmodmodmodulomodulomulmulmultiplymultiplynenenenenegnotBetweennotBetweennotBetweennotBetweennotBetweenSymmetricnotBetweenSymmetricnotBetweenSymmetricnotBetweenSymmetricnotContainsnotContainsnotContainsIgnoreCasenotContainsIgnoreCasenotEqualnotEqualnotEqualnotEqualnotEqualIgnoreCasenotEqualIgnoreCasenotInnotInnotInnotInnotInnotLikenotLikenotLikenotLikenotLikenotLikeIgnoreCasenotLikeIgnoreCasenotLikeIgnoreCasenotLikeIgnoreCasenotLikeRegexnotLikeRegexnotSimilarTonotSimilarTonotSimilarTonotSimilarTonotSimilarTonullifnullifnullsFirstnullsLastnvlnvlnvl2nvl2octetLengthoriginalparenthesisedpluspluspositionpositionpowpowpowerpowerprojectionSizeradremremrepeatrepeatreplacereplacereplacereplaceresetroundroundrpadrpadrpadrpadrtrimshlshlshrshrsignsimilarTosimilarTosimilarTosimilarTosimilarTosinsinhsortsortsortAscsortAscsortDefaultsortDescsortDescsqrtstartsWithstartsWithstartsWithIgnoreCasestartsWithIgnoreCasestddevPopstddevPopOverstddevSampstddevSampOversubsubsubstringsubstringsubstringsubstringsubtractsubtractsumsumOvertantanhtimestimestrimunaryMinusunaryPlusuppervarPopvarPopOvervarSampvarSampOver

Field Detail

CLAUSESback to summary
private static final Clause[] CLAUSES

Hides org.jooq.impl.AbstractField.CLAUSES.

Deprecated

as a consequence of Clause being deprecated. See corresponding docs for further information.

Constructor Detail

CustomFieldback to summary
protected CustomField(String name, DataType<T> type)
CustomFieldback to summary
protected CustomField(Name name, DataType<T> type)

Method Detail

acceptback to summary
public abstract void accept(Context<?> ctx)

Redeclares org.jooq.QueryPartInternal.accept.

Implements abstract org.jooq.impl.AbstractField.accept.

Doc from org.jooq.QueryPartInternal.accept.

Subclasses must implement this method.

This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.
Annotations
@Override
asback to summary
public final Field<T> as(Name alias)

Overrides org.jooq.impl.AbstractField.as.

Implements org.jooq.Field.as.

Doc from org.jooq.SelectField.as.

Deprecated

as a consequence of Field being deprecated. See corresponding docs for further information.

Create an alias for this field.

Note that the case-sensitivity of the returned field depends on Settings#getRenderQuotedNames() and the Name. By default, field aliases are quoted, and thus case-sensitive in many SQL dialects - use DSL#unquotedName(String...) for case-insensitive aliases.

If the argument Name#getName() is qualified, then the Name#last() part will be used.

Parameters
alias:Name

The alias name

Returns:Field<T>

The field alias

Annotations
@Override
clausesback to summary
public final Clause[] clauses(Context<?> ctx)

Overrides org.jooq.impl.AbstractField.clauses.

Implements org.jooq.QueryPartInternal.clauses.

Doc from org.jooq.QueryPartInternal.clauses.

Deprecated

as a consequence of Clause being deprecated. See corresponding docs for further information.

The Clauses that are represented by this query part.

QueryParts can specify several Clauses for which an event will be emitted before (in forward order) and after (in reverse order) visiting the the query part through Context#visit(QueryPart)

This method is for JOOQ INTERNAL USE only. Do not reference directly

Returns:Clause[]

The Clauses represented by this query part or null or an empty array if this query part does not represent a clause.

Annotations
@Override
declaresFieldsback to summary
public final boolean declaresFields()

Overrides org.jooq.impl.AbstractQueryPart.declaresFields.

Implements org.jooq.QueryPartInternal.declaresFields.

Doc from org.jooq.impl.AbstractQueryPart.declaresFields.

Subclasses may override this

Annotations
@Override
declaresTablesback to summary
public final boolean declaresTables()

Overrides org.jooq.impl.AbstractQueryPart.declaresTables.

Implements org.jooq.QueryPartInternal.declaresTables.

Doc from org.jooq.impl.AbstractQueryPart.declaresTables.

Subclasses may override this

Annotations
@Override
ofback to summary
public static final <T> CustomField<T> of(String name, DataType<T> type, Consumer<? super Context<?>> consumer)

Deprecated

as a consequence of CustomField being deprecated. See corresponding docs for further information.

Create a CustomField from a lambda expression.

ofback to summary
public static final <T> CustomField<T> of(Name name, DataType<T> type, Consumer<? super Context<?>> consumer)

Deprecated

as a consequence of CustomField being deprecated. See corresponding docs for further information.

Create a CustomField from a lambda expression.