org.trafodion.jdbc.t4

Class T4DSProperties

java.lang.Object

org.trafodion.jdbc.t4.T4Properties

org.trafodion.jdbc.t4.T4DSProperties

Direct Known Subclasses:

TrafT4ConnectionPoolDataSource, TrafT4DataSource

public class T4DSProperties
extends T4Properties

JDBC Type 4 driver data source connetion properties class.

Description: The T4DSProperties class contains all the properties associated with Type 4 data source connection. T4DSProperties is inherited by the TrafT4DataSource, TrafT4ConnectionPooledDataSource classes for configuring Type 4 connection properties.

The properties passed to the Type 4 driver have this precedence order in event of the values set through more than one option:

1. java.util.properties parameter in the DriverManager.getConnection call or through DataSource.setXXX() call.

2. java.util.properties file properties set through -Dt4jdbc.properties option.

3. Command line properties using -D option. All the system properties passed through the command-line option have to be prefixed with t4jdbc, to distinguish JDBC Type 4 driver properties from other system properties. For example: property user when specified with -D has to be qualified as -Dt4jdbc.user=super.super.

Copyright: (C) Apache Software Foundation (ASF)

Constructor Summary

Constructors

Constructor and Description
T4DSProperties()
T4DSProperties(Properties props)

Method Summary

Methods

Modifier and Type	Method and Description
String	getBlobTableName() Retrieves the table name used to store BLOB data for all BLOB columns accessed in the connection using the data source.
String	getCatalog() Gets the default catalog that will be used to access SQL objects referenced in SQL statements if the SQL objects are not fully qualified.
String	getClobTableName() Retrieves the table name used to store CBLOB data for all CLOB columns accessed in the connection using the data source.
int	getConnectionTimeout()
String	getDataSourceName() Returns the client's data source name.
String	getDescription() Returns the description associated with the current Type 4 connection.
int	getInitialPoolSize() Returns the number of physical connections that the pool should be created with.
Locale	getLocale() Returns the java.util.Locale object associated with the current Type 4 connection.
int	getLoginTimeout() Returns the login timeout value set for the current Type 4 connection.
int	getMaxIdleTime() Returns the max idle time value associated with this Type 4 connection.
int	getMaxPoolSize() Returns the maximum number of physical connections that the pool (free and inuse) should contain.
int	getMaxStatements() Returns the total number of statements that can be cached.
int	getMinPoolSize() Returns the number of physical connections the pool should keep in the free pool.
int	getNetworkTimeout() Returns the network timeout value set for the current Type 4 connection.
long	getReserveDataLocator() Returns the value of the reserve data locator length.
int	getRoundingMode() Returns the rounding mode set for the driver as an Integer value with one of the following values.
String	getSchema() Gets the default schema that will be used to access SQL objects referenced in SQL statements if the SQL objects are not fully qualified.
String	getServerDataSource() Returns the NDCS server-side data source name used for the current Type 4 connection.
String	getT4LogFile() Returns the Type 4 log file location associated with the current Type 4 connection.
Level	getT4LogLevel() Returns the Type 4 log level associated with the current Type 4 connection.
String	getUrl() Returns the URL used in the current Type 4 connection.
String	getURL() Deprecated. Use the getUrl() to obtain the URL string.
String	getUser() Returns the Safeguard user name associated with this Type 4 connection.
void	setBlobTableName(String blobTableName) Sets the table name to store and retrieve the BLOB data for all BLOB columns accessed in the connection using the data source.
void	setCatalog(String catalog) Sets the default catalog that will be used to access SQL objects referenced in SQL statements if the SQL objects are not fully qualified.
void	setClobTableName(String clobTableName) Sets the table name to store and retrieve the CLOB data for all CLOB columns accessed in the connection using the data source.
void	setConnectionTimeout(int connectionTimeout)
void	setConnectionTimeout(String connectionTimeout)
void	setDataSourceName(String dataSourceName) Sets the data source name for the current Type 4 connection.
void	setDescription(String description) Sets the description for the current Type 4 connection.
void	setInitialPoolSize(int initialPoolSize) The initial number of physical connections that the pool should be created with.
void	setInitialPoolSize(String initialPoolSize) The initial number of physical connections that the pool should be created with.
void	setLoginTimeout(int loginTimeout) Sets the login timeout in seconds for the Type 4 connection.
void	setLoginTimeout(String loginTimeout) Sets the login timeout in seconds for the Type 4 connection.
void	setMaxIdleTime(int maxIdleTime) Sets the max idle time value for the Type 4 connection.The default is set to 0 (no timeout).
void	setMaxIdleTime(String maxIdleTime) Sets the max idle time value for the Type 4 connection.
void	setMaxPoolSize(int maxPoolSize) The maximum number of physical connections that the pool (free and in-use) should contain.
void	setMaxPoolSize(String maxPoolSize) The maximum number of physical connections that the pool (free and in-use) should contain.
void	setMaxStatements(int maxStatements) Total number of statements that can be cached.
void	setMaxStatements(String maxStatements) Total number of statements that can be cached.
void	setMinPoolSize(int minPoolSize) Sets the number of physical connections the pool should keep available at all times.
void	setMinPoolSize(String minPoolSize) Sets the number of physical connections the pool should keep available at all times.
void	setNetworkTimeout(int networkTimeout) Sets the network timeout in seconds for the Type 4 connection.
void	setNetworkTimeout(String networkTimeout) Sets the network timeout in seconds for the Type 4 connection.
void	setPassword(String pwd) Sets the Safeguard password to be used for authentication when connecting to the NDCS server.
void	setReserveDataLocator(long reserveDataLocatorLen) Configures the number of data locators to be reserved by the Type 4 connection.
void	setReserveDataLocator(String reserveDataLocator) Configures the number of data locators to be reserved by the Type 4 connection.
void	setRoundingMode(int roundMode) Sets the round mode behaviour for the driver.
void	setRoundingMode(String roundMode) Sets the round mode behaviour for the driver.
void	setSchema(String schema) Sets the default schema that will be used to access SQL objects referenced in SQL statements if the SQL objects are not fully qualified.
void	setServerDataSource(String serverDataSource) Sets the NDCS server data source name.
void	setT4LogFile(String t4LogFile) Sets the location of the file to which the logging is to be done.
void	setT4LogLevel(String level) Sets the logging level for the current Type 4 connection.
void	setUrl(String url) Sets the URL for the Type 4 connection.
Properties	setURL(String url) Sets the URL for the Type 4 connection.
void	setUser(String user) Sets the Safeguard user name to be used while connecting to NDCS server for authentication.

Methods inherited from class org.trafodion.jdbc.t4.T4Properties

getApplicationName, getCertificateDir, getCertificateFile, getCertificateFileActive, getCompression, getCpuToUse, getDelayedErrorMode, getKeepAlive, getKeepRawFetchBuffer, getLogWriter, getProperties, getReplacementString, getRoleName, getSessionName, getSPJEnv, getTcpNoDelay, getTokenAuth, setApplicationName, setCertificateDir, setCertificateFile, setCertificateFileActive, setCompression, setCompression, setCpuToUse, setCpuToUse, setDelayedErrorMode, setDelayedErrorMode, setKeepAlive, setKeepAlive, setKeepRawFetchBuffer, setKeepRawFetchBuffer, setLogWriter, setReplacementString, setRoleName, setSessionName, setSPJEnv, setSPJEnv, setTcp_NoDelay, setTcpNoDelay, setTokenAuth, setTokenAuth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

T4DSProperties

public T4DSProperties()

T4DSProperties

public T4DSProperties(Properties props)

Method Detail

setDescription

public void setDescription(String description)

Sets the description for the current Type 4 connection.

Parameters:

description - For the current Type 4 connection.

See Also:

getDescription()

getDescription

public String getDescription()

Returns the description associated with the current Type 4 connection.

Returns:

The description associated with the current Type 4 connection.

See Also:

setDescription(String)

setDataSourceName

public void setDataSourceName(String dataSourceName)

Sets the data source name for the current Type 4 connection.

Parameters:

dataSourceName - For the client side DataSource object.

See Also:

getDataSourceName()

getDataSourceName

public String getDataSourceName()

Returns the client's data source name.

Returns:

data source name.

See Also:

setDataSourceName(String)

setServerDataSource

public void setServerDataSource(String serverDataSource)

Sets the NDCS server data source name. The NDCS server data source is defined by NDCS on the server.

Parameters:

serverDataSource - the NDCS data source name to use on the NDCS server side. The default value is an empty string.

See Also:

#getServerDataSourceName()

getServerDataSource

public String getServerDataSource()

Returns the NDCS server-side data source name used for the current Type 4 connection.

Returns:

NDCS server-side data source name.

See Also:

setServerDataSource(String)

setCatalog

public void setCatalog(String catalog)

Sets the default catalog that will be used to access SQL objects referenced in SQL statements if the SQL objects are not fully qualified.

Parameters:

catalog - Database catalog name. The default catalog name is set by the DCS server-side data source.

See Also:

getCatalog()

getCatalog

public String getCatalog()

Gets the default catalog that will be used to access SQL objects referenced in SQL statements if the SQL objects are not fully qualified.

Returns:

TrafT4 catalog name.

See Also:

setCatalog(String)

setSchema

public void setSchema(String schema)

Sets the default schema that will be used to access SQL objects referenced in SQL statements if the SQL objects are not fully qualified.

Parameters:

schema - Database schema name. The default schema name is set by the DCS server side data source.

See Also:

getSchema()

getSchema

public String getSchema()

Gets the default schema that will be used to access SQL objects referenced in SQL statements if the SQL objects are not fully qualified.

Returns:

The schema associated with the current Type 4 connection.

See Also:

setSchema(String)

getLocale

public Locale getLocale()

Returns the java.util.Locale object associated with the current Type 4 connection.

Returns:

java.util.Locale object.

See Also:

T4Properties.setLanguage(String language)

setMaxPoolSize

public void setMaxPoolSize(String maxPoolSize)

The maximum number of physical connections that the pool (free and in-use) should contain. When the maximum number of physical connections is reached, the Type 4 driver throws an SQLException with the message "Maximum pool size reached." Specifying a value of 0 (zero) indicates there is no maximum size for the pool. Specifying a value of -1 indicates no connection pooling is performed. The default value is -1, indicating that no pooling of physical connections is done.

Parameters:

maxPoolSize - the maximum number of physical connections the pool should contain (free and in use).

See Also:

getMaxPoolSize(), setMaxPoolSize(int)

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

The maximum number of physical connections that the pool (free and in-use) should contain. When the maximum number of physical connections is reached, the Type 4 driver throws an SQLException with the message "Maximum pool size reached." Specifying a value of 0 (zero) indicates there is no maximum size for the pool. Specifying a value of -1 indicates no connection pooling is performed. The default value is -1, indicating that no pooling of physical connections is done.

Parameters:

maxPoolSize - the maximum number of physical connections the pool should contain (free and in use).

See Also:

getMaxPoolSize(), setMaxPoolSize(String)

getMaxPoolSize

public int getMaxPoolSize()

Returns the maximum number of physical connections that the pool (free and inuse) should contain. A value of zero (0) indicates no maximum size. A value of -1 indicates that connection pooling is not being done.

Returns:

the maximum number of physical connections that the pool should contain.

See Also:

setMaxPoolSize(int)

setMinPoolSize

public void setMinPoolSize(String minPoolSize)

Sets the number of physical connections the pool should keep available at all times.

Parameters:

minPoolSize - Limits the number of physical connection that can be in the free pool. When the number of physical connections in the free pool reaches the value of minPoolSize, subsequent connections that are closed are physically closed and are not added to the free pool. Specifying a value of 0 means that the value of minPoolSize is the same as the value of maxPoolSize. If the value of maxPoolSize is -1, the value of minPoolSize is ignored. The default value is 0. For this data source, it is recommended that you use the default value.

See Also:

getMinPoolSize(), setMinPoolSize(int minPoolSize)

setMinPoolSize

public void setMinPoolSize(int minPoolSize)

Sets the number of physical connections the pool should keep available at all times.

Parameters:

minPoolSize - Limits the number of physical connection that can be in the free pool. When the number of physical connections in the free pool reaches the value of minPoolSize, subsequent connections that are closed are physically closed and are not added to the free pool. Specifying a value of 0 means that the value of minPoolSize is the same as the value of maxPoolSize. If the value of maxPoolSize is -1, the value of minPoolSize is ignored. The default value is 0. For this data source, it is recommended that you use the default value.

See Also:

getMinPoolSize(), setMinPoolSize(String minPoolSize)

getMinPoolSize

public int getMinPoolSize()

Returns the number of physical connections the pool should keep in the free pool. A value of 0 (zero) indicates that minPoolSize is equal to maxPoolsize. If maxPoolsize is equal to -1, the value of minPoolSize is ignored. The default value is 0.

Returns:

The number of physical connections the pool should maintain in the free pool.

See Also:

setMinPoolSize(int), setMaxPoolSize(int)

setInitialPoolSize

public void setInitialPoolSize(String initialPoolSize)

The initial number of physical connections that the pool should be created with. Specifying a value of 0 (zero) or less indicates that the pool should not be created with any initial connections. The default value is -1 indicating that no initial pool of physical connections is created. The value can be less than minPoolSize but must be less than or equal to the value of maxPoolSize. Specifying a value greater than maxPoolSize will set the initialPoolSize to the value of maxPoolSize.

Parameters:

initialPoolSize - the initial number of physical connections the pool should be created with.

See Also:

setInitialPoolSize(int)

setInitialPoolSize

public void setInitialPoolSize(int initialPoolSize)

The initial number of physical connections that the pool should be created with. Specifying a value of 0 (zero) or less indicates that the pool should not be created with any initial connections. The default value is -1 indicating that no initial pool of physical connections is created. The value can be less than minPoolSize but must be less than or equal to the value of maxPoolSize. Specifying a value greater than maxPoolSize will set the initialPoolSize to the value of maxPoolSize.

Parameters:

initialPoolSize - the initial number of physical connections the pool should be created with.

See Also:

setInitialPoolSize(String)

getInitialPoolSize

public int getInitialPoolSize()

Returns the number of physical connections that the pool should be created with. A value of -1 indicates that the pool is not created with any initial connections.

Returns:

initialPoolSize the number of physical connections that the pool should be created with.

See Also:

setInitialPoolSize(int)

setMaxStatements

public void setMaxStatements(String maxStatements)

Total number of statements that can be cached. A value of zero (0) indicates that caching of statements is disabled.

Parameters:

maxStatements - The number of statements that can be cached.

See Also:

setMaxStatements(int)

setMaxStatements

public void setMaxStatements(int maxStatements)

Total number of statements that can be cached. A value of zero (0) indicates that caching of statements is disabled.

Parameters:

maxStatements - The number of statements that can be cached.

See Also:

setMaxStatements(String)

getMaxStatements

public int getMaxStatements()

Returns the total number of statements that can be cached. A value of zero (0) indicates that pooling of statements is disabled.

Returns:

The total number of statements that can be cached.

getURL

public String getURL()

Deprecated. Use the getUrl() to obtain the URL string.

Returns the URL used in the current Type 4 connection. JDBC Type 4 driver URL uses the format: jdbc:t4jdbc://host:port/:

Returns:

the URL string.

See Also:

getUrl()

setURL

public Properties setURL(String url)
                  throws SQLException

Sets the URL for the Type 4 connection. JDBC Type 4 driver URL uses the format: jdbc:t4jdbc://host:port/:prop-name=value. This validates the URL value and throws SQLException if the URL value is incorrect.

Parameters:

url - the URL.

Throws:

SQLException

See Also:

getUrl()

getUrl

public String getUrl()

Returns the URL used in the current Type 4 connection. JDBC Type 4 driver URL uses the format: jdbc:t4jdbc://host:port/[:][prop-name=value][,prop-name=value]...

Overrides:

getUrl in class T4Properties

Returns:

the URL string.

See Also:

setUrl(String)

setUrl

public void setUrl(String url)

Sets the URL for the Type 4 connection. JDBC Type 4 driver URL uses the format: jdbc:t4jdbc://host:port/[:][prop-name=value][,prop-name=value]... This method does not validate the URL value.

Parameters:

url - the URL.

See Also:

getUrl()

setUser

public void setUser(String user)

Sets the Safeguard user name to be used while connecting to NDCS server for authentication.

Parameters:

user - Sets the user for the current Type 4 connection.

See Also:

getUser()

getUser

public String getUser()

Returns the Safeguard user name associated with this Type 4 connection.

Returns:

The user name.

See Also:

setUser(String)

setPassword

public void setPassword(String pwd)

Sets the Safeguard password to be used for authentication when connecting to the NDCS server.

Parameters:

pwd - The Safeguard password for the current Type 4 connection.

setLoginTimeout

public void setLoginTimeout(String loginTimeout)

Sets the login timeout in seconds for the Type 4 connection. The default login timeout value is set to 60 seconds.

Parameters:

loginTimeout - The login timeout value in seconds.

See Also:

setLoginTimeout(int), getLoginTimeout()

setLoginTimeout

public void setLoginTimeout(int loginTimeout)

Sets the login timeout in seconds for the Type 4 connection. The default login timeout value is set to 60 seconds.

Parameters:

loginTimeout - The login timeout value in seconds.

See Also:

setLoginTimeout(String), getLoginTimeout()

getLoginTimeout

public int getLoginTimeout()

Returns the login timeout value set for the current Type 4 connection.

Returns:

the login timeout value in seconds.

See Also:

setLoginTimeout(int), setLoginTimeout(String)

setNetworkTimeout

public void setNetworkTimeout(String networkTimeout)

Sets the network timeout in seconds for the Type 4 connection. The default network timeout value is set to infinity.

Parameters:

networkTimeout - The network timeout value in seconds.

See Also:

setNetworkTimeout(int), getNetworkTimeout()

setNetworkTimeout

public void setNetworkTimeout(int networkTimeout)

Sets the network timeout in seconds for the Type 4 connection. The default network timeout value is set to infinity.

Parameters:

networkTimeout - The network timeout value in seconds.

See Also:

setNetworkTimeout(String), getNetworkTimeout()

getNetworkTimeout

public int getNetworkTimeout()

Returns the network timeout value set for the current Type 4 connection.

Returns:

The network timeout value in seconds.

See Also:

setNetworkTimeout(int), setNetworkTimeout(String)

setConnectionTimeout

public void setConnectionTimeout(String connectionTimeout)

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

setMaxIdleTime

public void setMaxIdleTime(String maxIdleTime)

Sets the max idle time value for the Type 4 connection. The default is set to 0 (no timeout). Negative values are treated as 0.

Parameters:

maxIdleTime - The timeout value in seconds.

See Also:

setMaxIdleTime(int)

setMaxIdleTime

public void setMaxIdleTime(int maxIdleTime)

Sets the max idle time value for the Type 4 connection.The default is set to 0 (no timeout). Negative values are treated as 0.

Parameters:

maxIdleTime - The timeout value in seconds.

See Also:

setMaxIdleTime(String)

getConnectionTimeout

public int getConnectionTimeout()

getMaxIdleTime

public int getMaxIdleTime()

Returns the max idle time value associated with this Type 4 connection.

Returns:

The max idle timeout value in seconds.

See Also:

setMaxIdleTime(int)

setT4LogLevel

public void setT4LogLevel(String level)

Sets the logging level for the current Type 4 connection. The default value is OFF. Valid values are:

   OFF    (no logging)
   SEVERE (highest value)
   WARNING
   INFO
   CONFIG
   FINE
   FINER
   FINEST (lowest value).
   ALL    (log all messages)
 

Parameters:

level - logging level.

See Also:

getT4LogLevel(), Level

getT4LogLevel

public Level getT4LogLevel()

Returns the Type 4 log level associated with the current Type 4 connection. Possible log levels are described in java.util.logging.Level

Returns:

java.util.logging.Level associated with the current Type 4 connection.

See Also:

setT4LogLevel(String), Level

setT4LogFile

public void setT4LogFile(String t4LogFile)

Sets the location of the file to which the logging is to be done. Changing this location after making a connection has no effect; because the driver reads this property before the connection is made. The default name is a generated file name defined by the following pattern: %h/t4jdbc%u.log where: "/" represents the local pathname separator "%h" represents the value of the "user.home" system property. If %h is not defined, then the behavior is undefined "%u" represents a unique number to resolve conflicts

Parameters:

t4LogFile - The Type 4 log file location. If the parameter is null, then the T4LogFile is set to the global log file.

See Also:

getT4LogFile(), Logger

getT4LogFile

public String getT4LogFile()

Returns the Type 4 log file location associated with the current Type 4 connection.

Returns:

The Type 4 log file location.

See Also:

setT4LogFile(String)

setClobTableName

public void setClobTableName(String clobTableName)
                      throws SQLException

Sets the table name to store and retrieve the CLOB data for all CLOB columns accessed in the connection using the data source.

Parameters:

clobTableName - The clob table name, which is in the format catalog_name.schema_name.clob_table_name

Throws:

SQLException

Since:

1.1

getClobTableName

public String getClobTableName()

Retrieves the table name used to store CBLOB data for all CLOB columns accessed in the connection using the data source.

Returns:

the clob table name, which is in the format catalog_name.schema_name.clob_table_name

Since:

1.1

setBlobTableName

public void setBlobTableName(String blobTableName)
                      throws SQLException

Sets the table name to store and retrieve the BLOB data for all BLOB columns accessed in the connection using the data source.

Parameters:

blobTableName - the blob table name, which is in the format catalog_name.schema_name.blob_table_name

Throws:

SQLException

Since:

1.1

getBlobTableName

public String getBlobTableName()

Retrieves the table name used to store BLOB data for all BLOB columns accessed in the connection using the data source.

Returns:

the blob table name which is of the format catalog_name.schema_name.blob_table_name

Since:

1.1

setReserveDataLocator

public void setReserveDataLocator(String reserveDataLocator)

Configures the number of data locators to be reserved by the Type 4 connection. Default value is 100.

Parameters:

reserveDataLocator - Sets the value of the reserve data locator length for the binding) feature.

Since:

1.1

setReserveDataLocator

public void setReserveDataLocator(long reserveDataLocatorLen)

Configures the number of data locators to be reserved by the Type 4 connection. Default value is 100.

Parameters:

reserveDataLocatorLen - Sets the value of the reserve data locator length for the Type 4 connection.

Since:

1.1

getReserveDataLocator

public long getReserveDataLocator()

Returns the value of the reserve data locator length.

Returns:

The value of the reserved data locator length.

Since:

1.1

getRoundingMode

public int getRoundingMode()

Description copied from class: T4Properties

Returns the rounding mode set for the driver as an Integer value with one of the following values. static int ROUND_CEILING Rounding mode to round towards positive infinity. static int ROUND_DOWN Rounding mode to round towards zero. static int ROUND_FLOOR Rounding mode to round towards negative infinity. static int ROUND_HALF_DOWN Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down. static int ROUND_HALF_EVEN Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor. static int ROUND_HALF_UP Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up. static int ROUND_UNNECESSARY Rounding mode to assert that the requested operation has an exact result, hence no rounding is necessary. static int ROUND_UP Rounding mode to round away from zero.

Returns:

Returns the rounding mode set for the driver as an Integer value with one of the values:

 static int ROUND_CEILING
       Rounding mode to round toward positive infinity.
 static int ROUND_DOWN
       Rounding mode to round toward zero.
 static int ROUND_FLOOR
      Rounding mode to round toward negative infinity.
 static int ROUND_HALF_DOWN
      Rounding mode to round toward "nearest neighbor" unless both
      neighbors are equidistant, in which case round down.
 static int ROUND_HALF_EVEN
      Rounding mode to round toward the "nearest neighbor" unless
      both neighbors are equidistant, in which case, round towards the even neighbor.
 static int ROUND_HALF_UP
      Rounding mode to round toward "nearest neighbor" unless both
      neighbors are equidistant, in which case round up.
 static int ROUND_UNNECESSARY
      Rounding mode to assert that the requested operation has an exact
      result; hence no rounding is necessary.
 static int ROUND_UP
      Rounding mode to round away from zero.
 

setRoundingMode

public void setRoundingMode(String roundMode)

Sets the round mode behaviour for the driver.

Parameters:

roundMode - String value with one of the values:

 static int ROUND_CEILING
       Rounding mode to round toward positive infinity.
 static int ROUND_DOWN
       Rounding mode to round toward zero.
 static int ROUND_FLOOR
      Rounding mode to round toward negative infinity.
 static int ROUND_HALF_DOWN
      Rounding mode to round toward "nearest neighbor" unless both
      neighbors are equidistant, in which case round down.
 static int ROUND_HALF_EVEN
      Rounding mode to round toward the "nearest neighbor" unless
      both neighbors are equidistant, in which case, round towards the even neighbor.
 static int ROUND_HALF_UP
      Rounding mode to round toward "nearest neighbor" unless both
      neighbors are equidistant, in which case round up.
 static int ROUND_UNNECESSARY
      Rounding mode to assert that the requested operation has an exact
      result; hence no rounding is necessary.
 static int ROUND_UP
      Rounding mode to round away from zero.
 

The default value is ROUND_HALF_EVEN.

setRoundingMode

public void setRoundingMode(int roundMode)

Sets the round mode behaviour for the driver.

Parameters:

roundMode - Integer value with one of the values:

 static int ROUND_CEILING
       Rounding mode to round toward positive infinity.
 static int ROUND_DOWN
       Rounding mode to round toward zero.
 static int ROUND_FLOOR
      Rounding mode to round toward negative infinity.
 static int ROUND_HALF_DOWN
      Rounding mode to round toward "nearest neighbor" unless both
      neighbors are equidistant, in which case round down.
 static int ROUND_HALF_EVEN
      Rounding mode to round toward the "nearest neighbor" unless
      both neighbors are equidistant, in which case, round towards the even neighbor.
 static int ROUND_HALF_UP
      Rounding mode to round toward "nearest neighbor" unless both
      neighbors are equidistant, in which case round up.
 static int ROUND_UNNECESSARY
      Rounding mode to assert that the requested operation has an exact
      result; hence no rounding is necessary.
 static int ROUND_UP
      Rounding mode to round away from zero.
 

The default value is ROUND_HALF_EVEN.