Class AbstractAttachProperties<T extends IAttachProperties<T>>
- java.lang.Object
-
- org.firebirdsql.gds.ng.AbstractAttachProperties<T>
-
- All Implemented Interfaces:
IAttachProperties<T>,AttachmentProperties,BaseProperties
- Direct Known Subclasses:
FbConnectionProperties,FbServiceProperties
public abstract class AbstractAttachProperties<T extends IAttachProperties<T>> extends java.lang.Object implements IAttachProperties<T>
Abstract mutable implementation ofIAttachProperties.- Since:
- 3.0
- Author:
- Mark Rotteveel
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAbstractAttachProperties.PropertyUpdateListenerProperty update listener.
-
Field Summary
-
Fields inherited from interface org.firebirdsql.gds.ng.IAttachProperties
DEFAULT_CONNECT_TIMEOUT, DEFAULT_SO_TIMEOUT, DEFAULT_SOCKET_BUFFER_SIZE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractAttachProperties()Default constructor for AbstractAttachPropertiesprotectedAbstractAttachProperties(IAttachProperties<T> src)Copy constructor for IAttachProperties.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.util.Map<ConnectionProperty,java.lang.Object>connectionPropertyValues()An unmodifiable view on the connection properties held by this BaseProperties implementation.protected abstract voiddirtied()Called by setters if they have been called.booleanequals(java.lang.Object o)java.lang.BooleangetBooleanProperty(java.lang.String name)Retrieves abooleanproperty value by name.java.lang.IntegergetIntProperty(java.lang.String name)Retrieves anintproperty value by name.java.lang.StringgetProperty(java.lang.String name)Retrieves a string property value by name.inthashCode()booleanisImmutable()protected ConnectionPropertyproperty(java.lang.String name)Returns the property of the specified name.voidregisterPropertyUpdateListener(AbstractAttachProperties.PropertyUpdateListener listener)Registers an update listener that is notified when a connection property is modified.protected java.lang.ObjectresolveStoredDefaultValue(ConnectionProperty property)Resolve the default value for the specified connection property.voidsetBooleanProperty(java.lang.String name, java.lang.Boolean value)Sets abooleanproperty by name.voidsetIntProperty(java.lang.String name, java.lang.Integer value)Sets anintproperty by name.voidsetProperty(java.lang.String name, java.lang.String value)Sets a property by name.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.firebirdsql.jaybird.props.AttachmentProperties
getAuthPlugins, getCharSet, getConnectTimeout, getDbCryptConfig, getEncoding, getPassword, getPortNumber, getProcessId, getProcessName, getRoleName, getServerName, getSocketBufferSize, getSoTimeout, getType, getUser, getWireCrypt, isWireCompression, setAuthPlugins, setCharSet, setConnectTimeout, setDbCryptConfig, setEncoding, setPassword, setPortNumber, setProcessId, setProcessName, setRoleName, setServerName, setSocketBufferSize, setSoTimeout, setType, setUser, setWireCompression, setWireCrypt
-
Methods inherited from interface org.firebirdsql.jaybird.props.BaseProperties
getBooleanProperty, getIntProperty, getProperty
-
Methods inherited from interface org.firebirdsql.gds.ng.IAttachProperties
asImmutable, asNewMutable, getAttachObjectName, getWireCryptAsEnum, setAttachObjectName, setWireCryptAsEnum
-
-
-
-
Constructor Detail
-
AbstractAttachProperties
protected AbstractAttachProperties(IAttachProperties<T> src)
Copy constructor for IAttachProperties.All properties defined in
IAttachPropertiesare copied fromsrcto the new instance.- Parameters:
src- Source to copy from
-
AbstractAttachProperties
protected AbstractAttachProperties()
Default constructor for AbstractAttachProperties
-
-
Method Detail
-
setProperty
public final void setProperty(java.lang.String name, java.lang.String value)Description copied from interface:BasePropertiesSets a property by name.This method can be used to set all defined properties, but also properties not known by Jaybird. When setting
intorbooleanproperties, the appropriate conversions are applied. Usingnullwill reset to the default value. Forbooleanproperties, an empty string is taken to meantrue.- Specified by:
setPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)value- Property value (usenullto apply default)
-
getProperty
public final java.lang.String getProperty(java.lang.String name)
Description copied from interface:BasePropertiesRetrieves a string property value by name.For properties with an explicit default, this method should return the string presentation of that default, not
null. Forintorbooleanthe string equivalent is returned.- Specified by:
getPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)- Returns:
- Value of the property, or
nullwhen not set or not a known property
-
setIntProperty
public final void setIntProperty(java.lang.String name, java.lang.Integer value)Description copied from interface:BasePropertiesSets anintproperty by name.For implementation simplicity, it is allowed to also set string properties. The value set will be the string equivalent.
- Specified by:
setIntPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)value- Property value (usenullto apply default)
-
getIntProperty
public final java.lang.Integer getIntProperty(java.lang.String name)
Description copied from interface:BasePropertiesRetrieves anintproperty value by name.For properties with an explicit default, this method should return the integer presentation of that default. For implementation simplicity, it is allowed to convert any string property to
intinstead of checking if something is actually anintproperty- Specified by:
getIntPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)- Returns:
- Integer with value of the property, or
nullwhen not set
-
setBooleanProperty
public final void setBooleanProperty(java.lang.String name, java.lang.Boolean value)Description copied from interface:BasePropertiesSets abooleanproperty by name.For implementation simplicity, it is allowed to also set string properties. The value set will be the string equivalent.
- Specified by:
setBooleanPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)value- Property value (usenullto apply default)
-
getBooleanProperty
public final java.lang.Boolean getBooleanProperty(java.lang.String name)
Description copied from interface:BasePropertiesRetrieves abooleanproperty value by name.For properties with an explicit default, this method should return the boolean presentation of that default. For implementation simplicity, it is allowed to convert any string property to
booleaninstead of checking if something is actually anintproperty- Specified by:
getBooleanPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)- Returns:
- Integer with value of the property, or
nullwhen not set
-
resolveStoredDefaultValue
protected java.lang.Object resolveStoredDefaultValue(ConnectionProperty property)
Resolve the default value for the specified connection property.This method is only used for properties that must have a stored default value to function correctly.
- Parameters:
property- Connection property- Returns:
- Default value to apply (usually
null)
-
property
protected final ConnectionProperty property(java.lang.String name)
Returns the property of the specified name.When the property is not a known property, an unknown variant is returned.
- Parameters:
name- Property name- Returns:
- A connection property instance, never
null
-
connectionPropertyValues
public final java.util.Map<ConnectionProperty,java.lang.Object> connectionPropertyValues()
Description copied from interface:BasePropertiesAn unmodifiable view on the connection properties held by this BaseProperties implementation.Be aware, implementations can have additional properties that are not mapped from
ConnectionProperty. Such properties will need to be retrieved in an implementation-specific manner.- Specified by:
connectionPropertyValuesin interfaceBaseProperties- Returns:
- An unmodifiable view on the property values held in this properties instance
-
isImmutable
public final boolean isImmutable()
- Specified by:
isImmutablein interfaceIAttachProperties<T extends IAttachProperties<T>>- Returns:
trueif this is an immutable implementation,falseif mutable
-
registerPropertyUpdateListener
@InternalApi public void registerPropertyUpdateListener(AbstractAttachProperties.PropertyUpdateListener listener)
Registers an update listener that is notified when a connection property is modified.This method is only for internal use within Jaybird.
- Parameters:
listener- Listener to register ornullto unregister- Throws:
java.lang.IllegalStateException- When a property update listener was already registered
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
dirtied
protected abstract void dirtied()
Called by setters if they have been called.
-
-