ForcedType (jOOQ Meta 3.14.15 API)

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:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`binding`
`protected String`	`converter`
`protected Boolean`	`enumConverter`
`protected String`	`excludeExpression`
`protected String`	`excludeTypes`
`protected String`	`expression`
`protected String`	`expressions`
`protected String`	`includeExpression`
`protected String`	`includeTypes`
`protected LambdaConverter`	`lambdaConverter`
`protected String`	`name`
`protected Nullability`	`nullability`
`protected ForcedTypeObjectType`	`objectType`
`protected String`	`sql`
`protected String`	`types`
`protected String`	`userType`

Constructor Summary

Constructors
Constructor and Description

ForcedType()

Constructors
Constructor and Description
`ForcedType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendTo(XMLBuilder builder)`
`boolean`	`equals(Object that)`
`String`	`getBinding()` A `Binding` implementation for the custom type.
`String`	`getConverter()` A converter implementation for the `getUserType()`.
`String`	`getExcludeExpression()` A Java regular expression matching columns, parameters, attributes, etc. which must not have this type.
`String`	`getExcludeTypes()` A Java regular expression matching data types which must not have this type.
`String`	`getExpression()` The same as `getIncludeExpression()`.
`String`	`getExpressions()` The same as `getIncludeExpression()`.
`String`	`getIncludeExpression()` A Java regular expression matching columns, parameters, attributes, etc. to be forced to have this type.
`String`	`getIncludeTypes()` A Java regular expression matching data types to be forced to have this type.
`LambdaConverter`	`getLambdaConverter()` A lambda converter implementation for the `getUserType()`.
`String`	`getName()` The name (in `SQLDataType`) to force any matches to
`Nullability`	`getNullability()` Whether this forced type should apply to nullable / non-nullable / all columns
`ForcedTypeObjectType`	`getObjectType()` Whether this forced type should apply to all object types, or only to specific ones
`String`	`getSql()` A SQL statement that produces a table with one column containing the matched qualified or unqualified column names.
`String`	`getTypes()` The same as `getIncludeTypes()`.
`String`	`getUserType()` The type of the user type - e.g. java.time.LocalDateTime.
`int`	`hashCode()`
`Boolean`	`isEnumConverter()` Whether the converter is an `EnumConverter`.
`void`	`setBinding(String value)` A `Binding` implementation for the custom type.
`void`	`setConverter(String value)` A converter implementation for the `getUserType()`.
`void`	`setEnumConverter(Boolean value)` Sets the value of the enumConverter property.
`void`	`setExcludeExpression(String value)` A Java regular expression matching columns, parameters, attributes, etc. which must not have this type.
`void`	`setExcludeTypes(String value)` A Java regular expression matching data types which must not have this type.
`void`	`setExpression(String value)` The same as `getIncludeExpression()`.
`void`	`setExpressions(String value)` The same as `getIncludeExpression()`.
`void`	`setIncludeExpression(String value)` A Java regular expression matching columns, parameters, attributes, etc. to be forced to have this type.
`void`	`setIncludeTypes(String value)` A Java regular expression matching data types to be forced to have this type.
`void`	`setLambdaConverter(LambdaConverter value)` A lambda converter implementation for the `getUserType()`.
`void`	`setName(String value)` The name (in `SQLDataType`) to force any matches to
`void`	`setNullability(Nullability value)` Whether this forced type should apply to nullable / non-nullable / all columns
`void`	`setObjectType(ForcedTypeObjectType value)` Whether this forced type should apply to all object types, or only to specific ones
`void`	`setSql(String value)` A SQL statement that produces a table with one column containing the matched qualified or unqualified column names.
`void`	`setTypes(String value)` The same as `getIncludeTypes()`.
`void`	`setUserType(String value)` The type of the user type - e.g. java.time.LocalDateTime.
`String`	`toString()`
`ForcedType`	`withBinding(String value)` A `Binding` implementation for the custom type.
`ForcedType`	`withConverter(String value)` A converter implementation for the `getUserType()`.
`ForcedType`	`withEnumConverter(Boolean value)`
`ForcedType`	`withExcludeExpression(String value)` A Java regular expression matching columns, parameters, attributes, etc. which must not have this type.
`ForcedType`	`withExcludeTypes(String value)` A Java regular expression matching data types which must not have this type.
`ForcedType`	`withExpression(String value)` The same as `getIncludeExpression()`.
`ForcedType`	`withExpressions(String value)` The same as `getIncludeExpression()`.
`ForcedType`	`withIncludeExpression(String value)` A Java regular expression matching columns, parameters, attributes, etc. to be forced to have this type.
`ForcedType`	`withIncludeTypes(String value)` A Java regular expression matching data types to be forced to have this type.
`ForcedType`	`withLambdaConverter(LambdaConverter value)` A lambda converter implementation for the `getUserType()`.
`ForcedType`	`withName(String value)` The name (in `SQLDataType`) to force any matches to
`ForcedType`	`withNullability(Nullability value)` Whether this forced type should apply to nullable / non-nullable / all columns
`ForcedType`	`withObjectType(ForcedTypeObjectType value)` Whether this forced type should apply to all object types, or only to specific ones
`ForcedType`	`withSql(String value)` A SQL statement that produces a table with one column containing the matched qualified or unqualified column names.
`ForcedType`	`withTypes(String value)` The same as `getIncludeTypes()`.
`ForcedType`	`withUserType(String value)` The type of the user type - e.g. java.time.LocalDateTime.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
  - userType
```
protected String userType
```
  - converter
```
protected String converter
```
  - enumConverter
```
protected Boolean enumConverter
```
  - 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 Detail
  - ForcedType
```
public ForcedType()
```
- Method Detail
  - 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
  - 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)
```
    Sets the value of the enumConverter property.
    
    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
  - 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
  - withConverter
```
public ForcedType withConverter(String value)
```
    A converter implementation for the getUserType().
  - withEnumConverter
```
public ForcedType withEnumConverter(Boolean value)
```
  - 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

Class ForcedType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

userType

converter

enumConverter

lambdaConverter

binding

excludeExpression

includeExpression

expression

expressions

sql

excludeTypes

includeTypes

types

nullability

objectType

Constructor Detail

ForcedType

Method Detail

getName

setName

getUserType

setUserType

getConverter

setConverter

isEnumConverter

setEnumConverter

getLambdaConverter

setLambdaConverter

getBinding

setBinding

getExcludeExpression

setExcludeExpression

getIncludeExpression

setIncludeExpression

getExpression

setExpression

getExpressions

setExpressions

getSql

setSql

getExcludeTypes

setExcludeTypes

getIncludeTypes

setIncludeTypes

getTypes

setTypes

getNullability

setNullability

getObjectType

setObjectType

withName

withUserType

withConverter

withEnumConverter

withLambdaConverter

withBinding

withExcludeExpression

withIncludeExpression

withExpression

withExpressions

withSql

withExcludeTypes

withIncludeTypes

withTypes

withNullability

withObjectType

appendTo

toString

equals

hashCode