java.lang.Object
org.firebirdsql.jaybird.props.def.ConnectionProperty
A Jaybird connection property.
Holds information like name, aliases, default value etc for a Jaybird connection property.
- Since:
- 5
- Author:
- Mark Rotteveel
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionaliases()Optional aliases (secondary names) for this property.static ConnectionProperty.Builderbuilder()Creates a connection property builder.static ConnectionProperty.Builderchoices()Possible values for this property.intdpbItem()Database parameter buffer (DPB) item associated with this property.booleanbooleaninthashCode()booleanbooleanisIdenticalTo(ConnectionProperty other) Checks if the provided object is identical to this object.name()pbType()Type of the value when sent in the database (or service attach) parameter buffer.intspbItem()Service parameter buffer (SPB) item associated with this property.toString()type()Type of the property.static ConnectionPropertyCreates an unknown connection property.<T> Tvalidate(T value) Validatesvaluefor this property.
-
Field Details
-
NO_DPB_ITEM
public static final int NO_DPB_ITEM- See Also:
-
NO_SPB_ITEM
public static final int NO_SPB_ITEM- See Also:
-
-
Method Details
-
builder
Creates a connection property builder.- Returns:
- builder
-
builder
-
unknown
Creates an unknown connection property.An unknown connection property was either not defined but used, or can be used for lookups (given the definition of equals and hashcode). An unknown connection property returned by this method always applies type
ConnectionPropertyType.STRING- Parameters:
name- Property name- Returns:
- An unknown property with the specified name
-
name
- Returns:
- name of the property
-
aliases
Optional aliases (secondary names) for this property.Aliases are alternative names for the property, either for backwards compatibility or for ease of use.
- Returns:
- aliases for this property, empty means no aliases
- See Also:
-
type
Type of the property.- Returns:
- type of the property
-
choices
Possible values for this property.- Returns:
- possible values for this property, or empty when unrestricted
-
validate
public <T> T validate(T value) Validatesvaluefor this property.- Parameters:
value- value to validate- Returns:
valuewhen validation passed- Throws:
IllegalArgumentException- Whenvalueis not a valid value for this property
-
pbType
Type of the value when sent in the database (or service attach) parameter buffer.- Returns:
- type for the parameter buffer
-
dpbItem
public int dpbItem()Database parameter buffer (DPB) item associated with this property.- Returns:
- database parameter buffer item, or
NO_DPB_ITEMif no item is associated - See Also:
-
hasDpbItem
public boolean hasDpbItem()- Returns:
trueif this property has a DPB item- See Also:
-
spbItem
public int spbItem()Service parameter buffer (SPB) item associated with this property.- Returns:
- service parameter buffer item, or
NO_SPB_ITEMif no item is associated - See Also:
-
hasSpbItem
public boolean hasSpbItem()- Returns:
trueif this property has an SPB item- See Also:
-
toString
-
equals
Equality (and hash code) only considers the
name.Use
isIdenticalTo(ConnectionProperty)for checking full equality. -
hashCode
public int hashCode()The hashcode (and equals) only considers the
name. -
isIdenticalTo
Checks if the provided object is identical to this object.This supplements
equals(Object)which only checks thename.- Parameters:
other- Other connection property object- Returns:
trueif this is the same object or all fields have the same value,falseotherwise
-