Module org.jooq.meta
Package org.jooq.meta.jaxb

Class ForcedType

java.lang.Object
org.jooq.meta.jaxb.ForcedType
All Implemented Interfaces:
Serializable, XMLAppendable
public class ForcedType extends Object implements Serializable, XMLAppendable
A forced type declaration
See Also:

  • Field Details

    • priority

      protected Integer priority

    • name

      protected String name

    • userType

      protected String userType

    • visibilityModifier

      protected VisibilityModifier visibilityModifier

    • generator

      protected String generator

    • auditInsertTimestamp

      protected Boolean auditInsertTimestamp

    • auditInsertUser

      protected Boolean auditInsertUser

    • auditUpdateTimestamp

      protected Boolean auditUpdateTimestamp

    • auditUpdateUser

      protected Boolean auditUpdateUser

    • converter

      protected String converter

    • enumConverter

      protected Boolean enumConverter

    • xmlConverter

      protected Boolean xmlConverter

    • jsonConverter

      protected Boolean jsonConverter

    • lambdaConverter

      protected LambdaConverter lambdaConverter

    • binding

      protected String binding

    • excludeExpression

      protected String excludeExpression

    • includeExpression

      protected String includeExpression

    • expression

      protected String expression

    • expressions

      protected String expressions

    • sql

      protected String sql

    • excludeTypes

      protected String excludeTypes

    • includeTypes

      protected String includeTypes

    • types

      protected String types

    • nullability

      protected Nullability nullability

    • objectType

      protected ForcedTypeObjectType objectType

  • Constructor Details

    • ForcedType

      public ForcedType()

  • Method Details

    • getPriority

      public Integer getPriority()
      The priority among forced types in which to apply this one. Forced types of equal priority will be applied in the order in which they're added to the forced types list (e.g. the Maven lexical XML order)

    • setPriority

      public void setPriority(Integer value)
      The priority among forced types in which to apply this one. Forced types of equal priority will be applied in the order in which they're added to the forced types list (e.g. the Maven lexical XML order)

    • getName

      public String getName()
      The name (in SQLDataType) to force any matches to

    • setName

      public void setName(String value)
      The name (in SQLDataType) to force any matches to

    • getUserType

      public String getUserType()
      The type of the user type - e.g. java.time.LocalDateTime.

      If provided, getName() will be ignored, and either getConverter() or getBinding() is required

    • setUserType

      public void setUserType(String value)
      The type of the user type - e.g. java.time.LocalDateTime.

      If provided, getName() will be ignored, and either getConverter() or getBinding() is required

    • getVisibilityModifier

      public VisibilityModifier getVisibilityModifier()
      The visibility modifier to be used in generated code for the column that is matched by this forced type, if applicable.

      This has no effect on matched objects that are not columns.

      This feature is available in the commercial distribution only.

    • setVisibilityModifier

      public void setVisibilityModifier(VisibilityModifier value)
      The visibility modifier to be used in generated code for the column that is matched by this forced type, if applicable.

      This has no effect on matched objects that are not columns.

      This feature is available in the commercial distribution only.

    • getGenerator

      public String getGenerator()
      A Generator implementation used for client-side computed columns.

      This has no effect on matched objects that are not columns.

      This feature is available in the commercial distribution only.

    • setGenerator

      public void setGenerator(String value)
      A Generator implementation used for client-side computed columns.

      This has no effect on matched objects that are not columns.

      This feature is available in the commercial distribution only.

    • isAuditInsertTimestamp

      public Boolean isAuditInsertTimestamp()
      Whether this column acts as an audit GeneratorStatementType.INSERT timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

      Returns:
      possible object is Boolean

    • setAuditInsertTimestamp

      public void setAuditInsertTimestamp(Boolean value)
      Whether this column acts as an audit GeneratorStatementType.INSERT timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

      Parameters:
      value - allowed object is Boolean

    • isAuditInsertUser

      public Boolean isAuditInsertUser()
      Whether this column acts as an audit GeneratorStatementType.INSERT timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

      Returns:
      possible object is Boolean

    • setAuditInsertUser

      public void setAuditInsertUser(Boolean value)
      Whether this column acts as an audit GeneratorStatementType.INSERT timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

      Parameters:
      value - allowed object is Boolean

    • isAuditUpdateTimestamp

      public Boolean isAuditUpdateTimestamp()
      Whether this column acts as an audit GeneratorStatementType.UPDATE timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

      Returns:
      possible object is Boolean

    • setAuditUpdateTimestamp

      public void setAuditUpdateTimestamp(Boolean value)
      Whether this column acts as an audit GeneratorStatementType.UPDATE timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

      Parameters:
      value - allowed object is Boolean

    • isAuditUpdateUser

      public Boolean isAuditUpdateUser()
      Whether this column acts as an audit GeneratorStatementType.UPDATE timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

      Returns:
      possible object is Boolean

    • setAuditUpdateUser

      public void setAuditUpdateUser(Boolean value)
      Whether this column acts as an audit GeneratorStatementType.UPDATE timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

      Parameters:
      value - allowed object is Boolean

    • getConverter

      public String getConverter()
      A converter implementation for the getUserType().

    • setConverter

      public void setConverter(String value)
      A converter implementation for the getUserType().

    • isEnumConverter

      public Boolean isEnumConverter()
      Whether the converter is an EnumConverter.
      Returns:
      possible object is Boolean

    • setEnumConverter

      public void setEnumConverter(Boolean value)
      Whether the converter is an EnumConverter.
      Parameters:
      value - allowed object is Boolean

    • isXmlConverter

      public Boolean isXmlConverter()
      Whether the converter is an XMLtoJAXBConverter.
      Returns:
      possible object is Boolean

    • setXmlConverter

      public void setXmlConverter(Boolean value)
      Whether the converter is an XMLtoJAXBConverter.
      Parameters:
      value - allowed object is Boolean

    • isJsonConverter

      public Boolean isJsonConverter()
      Whether the converter is an org.jooq.jackson.extensions.converters.JSONtoJacksonConverter or a org.jooq.jackson.extensions.converters.JSONtoJacksonConverter.
      Returns:
      possible object is Boolean

    • setJsonConverter

      public void setJsonConverter(Boolean value)
      Whether the converter is an org.jooq.jackson.extensions.converters.JSONtoJacksonConverter or a org.jooq.jackson.extensions.converters.JSONtoJacksonConverter.
      Parameters:
      value - allowed object is Boolean

    • getLambdaConverter

      public LambdaConverter getLambdaConverter()
      A lambda converter implementation for the getUserType().

    • setLambdaConverter

      public void setLambdaConverter(LambdaConverter value)
      A lambda converter implementation for the getUserType().

    • getBinding

      public String getBinding()
      A Binding implementation for the custom type.

    • setBinding

      public void setBinding(String value)
      A Binding implementation for the custom type.

    • getExcludeExpression

      public String getExcludeExpression()
      A Java regular expression matching columns, parameters, attributes, etc. which must not have this type. Excludes match before includes, i.e. excludes have a higher priority.

    • setExcludeExpression

      public void setExcludeExpression(String value)
      A Java regular expression matching columns, parameters, attributes, etc. which must not have this type. Excludes match before includes, i.e. excludes have a higher priority.

    • getIncludeExpression

      public String getIncludeExpression()
      A Java regular expression matching columns, parameters, attributes, etc. to be forced to have this type. If provided, both "includeExpression" and "includeTypes" must match.

    • setIncludeExpression

      public void setIncludeExpression(String value)
      A Java regular expression matching columns, parameters, attributes, etc. to be forced to have this type. If provided, both "includeExpression" and "includeTypes" must match.

    • getExpression

      public String getExpression()
      The same as getIncludeExpression(). This is kept for backwards compatibility reasons.

    • setExpression

      public void setExpression(String value)
      The same as getIncludeExpression(). This is kept for backwards compatibility reasons.

    • getExpressions

      public String getExpressions()
      The same as getIncludeExpression(). This is kept for backwards compatibility reasons.

    • setExpressions

      public void setExpressions(String value)
      The same as getIncludeExpression(). This is kept for backwards compatibility reasons.

    • getSql

      public String getSql()
      A SQL statement that produces a table with one column containing the matched qualified or unqualified column names.

    • setSql

      public void setSql(String value)
      A SQL statement that produces a table with one column containing the matched qualified or unqualified column names.

    • getExcludeTypes

      public String getExcludeTypes()
      A Java regular expression matching data types which must not have this type. Excludes match before includes, i.e. excludes have a higher priority.

    • setExcludeTypes

      public void setExcludeTypes(String value)
      A Java regular expression matching data types which must not have this type. Excludes match before includes, i.e. excludes have a higher priority.

    • getIncludeTypes

      public String getIncludeTypes()
      A Java regular expression matching data types to be forced to have this type. If provided, both "includeExpression" and "includeTypes" must match.

    • setIncludeTypes

      public void setIncludeTypes(String value)
      A Java regular expression matching data types to be forced to have this type. If provided, both "includeExpression" and "includeTypes" must match.

    • getTypes

      public String getTypes()
      The same as getIncludeTypes(). This is kept for backwards compatibility reasons.

    • setTypes

      public void setTypes(String value)
      The same as getIncludeTypes(). This is kept for backwards compatibility reasons.

    • getNullability

      public Nullability getNullability()
      Whether this forced type should apply to nullable / non-nullable / all columns

    • setNullability

      public void setNullability(Nullability value)
      Whether this forced type should apply to nullable / non-nullable / all columns

    • getObjectType

      public ForcedTypeObjectType getObjectType()
      Whether this forced type should apply to all object types, or only to specific ones

    • setObjectType

      public void setObjectType(ForcedTypeObjectType value)
      Whether this forced type should apply to all object types, or only to specific ones

    • withPriority

      public ForcedType withPriority(Integer value)
      The priority among forced types in which to apply this one. Forced types of equal priority will be applied in the order in which they're added to the forced types list (e.g. the Maven lexical XML order)

    • withName

      public ForcedType withName(String value)
      The name (in SQLDataType) to force any matches to

    • withUserType

      public ForcedType withUserType(String value)
      The type of the user type - e.g. java.time.LocalDateTime.

      If provided, getName() will be ignored, and either getConverter() or getBinding() is required

    • withVisibilityModifier

      public ForcedType withVisibilityModifier(VisibilityModifier value)
      The visibility modifier to be used in generated code for the column that is matched by this forced type, if applicable.

      This has no effect on matched objects that are not columns.

      This feature is available in the commercial distribution only.

    • withGenerator

      public ForcedType withGenerator(String value)
      A Generator implementation used for client-side computed columns.

      This has no effect on matched objects that are not columns.

      This feature is available in the commercial distribution only.

    • withAuditInsertTimestamp

      public ForcedType withAuditInsertTimestamp(Boolean value)
      Whether this column acts as an audit GeneratorStatementType.INSERT timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

    • withAuditInsertUser

      public ForcedType withAuditInsertUser(Boolean value)
      Whether this column acts as an audit GeneratorStatementType.INSERT timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

    • withAuditUpdateTimestamp

      public ForcedType withAuditUpdateTimestamp(Boolean value)
      Whether this column acts as an audit GeneratorStatementType.UPDATE timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

    • withAuditUpdateUser

      public ForcedType withAuditUpdateUser(Boolean value)
      Whether this column acts as an audit GeneratorStatementType.UPDATE timestamp.

      This flag produces a generator configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.

      This feature is available in the commercial distribution only.

    • withConverter

      public ForcedType withConverter(String value)
      A converter implementation for the getUserType().

    • withEnumConverter

      public ForcedType withEnumConverter(Boolean value)
      Whether the converter is an EnumConverter.

    • withXmlConverter

      public ForcedType withXmlConverter(Boolean value)
      Whether the converter is an XMLtoJAXBConverter.

    • withJsonConverter

      public ForcedType withJsonConverter(Boolean value)
      Whether the converter is an org.jooq.jackson.extensions.converters.JSONtoJacksonConverter or a org.jooq.jackson.extensions.converters.JSONtoJacksonConverter.

    • withLambdaConverter

      public ForcedType withLambdaConverter(LambdaConverter value)
      A lambda converter implementation for the getUserType().

    • withBinding

      public ForcedType withBinding(String value)
      A Binding implementation for the custom type.

    • withExcludeExpression

      public ForcedType withExcludeExpression(String value)
      A Java regular expression matching columns, parameters, attributes, etc. which must not have this type. Excludes match before includes, i.e. excludes have a higher priority.

    • withIncludeExpression

      public ForcedType withIncludeExpression(String value)
      A Java regular expression matching columns, parameters, attributes, etc. to be forced to have this type. If provided, both "includeExpression" and "includeTypes" must match.

    • withExpression

      public ForcedType withExpression(String value)
      The same as getIncludeExpression(). This is kept for backwards compatibility reasons.

    • withExpressions

      public ForcedType withExpressions(String value)
      The same as getIncludeExpression(). This is kept for backwards compatibility reasons.

    • withSql

      public ForcedType withSql(String value)
      A SQL statement that produces a table with one column containing the matched qualified or unqualified column names.

    • withExcludeTypes

      public ForcedType withExcludeTypes(String value)
      A Java regular expression matching data types which must not have this type. Excludes match before includes, i.e. excludes have a higher priority.

    • withIncludeTypes

      public ForcedType withIncludeTypes(String value)
      A Java regular expression matching data types to be forced to have this type. If provided, both "includeExpression" and "includeTypes" must match.

    • withTypes

      public ForcedType withTypes(String value)
      The same as getIncludeTypes(). This is kept for backwards compatibility reasons.

    • withNullability

      public ForcedType withNullability(Nullability value)
      Whether this forced type should apply to nullable / non-nullable / all columns

    • withObjectType

      public ForcedType withObjectType(ForcedTypeObjectType value)
      Whether this forced type should apply to all object types, or only to specific ones

    • appendTo

      public final void appendTo(XMLBuilder builder)
      Specified by:
      appendTo in interface XMLAppendable

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object that)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object