MySQL Connector/J 9.2.0 · com.mysql.cj.result.Field · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private int	colDecimals
private short	colFlag
private int	collationIndex
private LazyString	columnName
private LazyString	databaseName
private String	encoding
private String	fullName
private long	length
private MysqlType	mysqlType
private int	mysqlTypeId
private LazyString	originalColumnName
private LazyString	originalTableName
private LazyString	tableName

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	Field(LazyString databaseName, LazyString tableName, LazyString originalTableName, LazyString columnName, LazyString originalColumnName, long length, int mysqlTypeId, short colFlag, int colDecimals, int collationIndex, String encoding, MysqlType mysqlType)
public	Field(String not used tableName, String not used columnName, int the MySQL collation/character set index collationIndex, String encoding of data in this field encoding, MysqlType `MysqlType` mysqlType, int length in characters or bytes (for BINARY data). length) Used by prepared statements to re-use result set data conversion methods when generating bound parameter retrieval instance for statement interceptors.

public

Field(LazyString databaseName, LazyString tableName, LazyString originalTableName, LazyString columnName, LazyString originalColumnName, long length, int mysqlTypeId, short colFlag, int colDecimals, int collationIndex, String encoding, MysqlType mysqlType)

public

Field(String

not used

tableName, String

not used

columnName, int

the MySQL collation/character set index

collationIndex, String

encoding of data in this field

encoding, MysqlType

MysqlType

mysqlType, int

length in characters or bytes (for BINARY data).

length)

Used by prepared statements to re-use result set data conversion methods when generating bound parameter retrieval instance for statement interceptors.

Method Summary

Modifier and Type	Method and Description
private void	adjustFlagsByMysqlType()
public int	getCollationIndex()
public String	getColumnLabel()
public String	getDatabaseName()
public int	getDecimals()
public String	Returns: the Java encoding getEncoding() Returns the Java encoding for this field.
public short	getFlags()
public String	getFullName()
public int	getJavaType()
public long	getLength()
public MysqlType	getMysqlType()
public int	getMysqlTypeId()
public String	getName()
public String	getOriginalName()
public String	getOriginalTableName()
public String	getTableName()
public boolean	getValueNeedsQuoting()
public boolean	isAutoIncrement()
public boolean	isBinary()
public boolean	isBlob()
public boolean	isFromFunction()
public boolean	isMultipleKey()
public boolean	isNotNull()
public boolean	isPrimaryKey()
public boolean	Returns: true if this field can not be written to in an INSERT/UPDATE statement. isReadOnly() Is this field _definitely_ not writable?
public boolean	isSingleBit()
public boolean	isUniqueKey()
public boolean	isUnsigned()
public boolean	isZeroFill()
public void	setBinary()
public void	setBlob()
public void	setFlags(short colFlag)
public void	setMysqlType(MysqlType mysqlType)
public void	setMysqlTypeId(int id)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

colDecimals	back to summary
private int colDecimals

colFlag	back to summary
private short colFlag

collationIndex	back to summary
private int collationIndex

columnName	back to summary
private LazyString columnName

databaseName	back to summary
private LazyString databaseName

encoding	back to summary
private String encoding

fullName	back to summary
private String fullName

length	back to summary
private long length

mysqlType	back to summary
private MysqlType mysqlType

mysqlTypeId	back to summary
private int mysqlTypeId

originalColumnName	back to summary
private LazyString originalColumnName

originalTableName	back to summary
private LazyString originalTableName

tableName	back to summary
private LazyString tableName

Constructor Detail

Field	back to summary
public Field(LazyString databaseName, LazyString tableName, LazyString originalTableName, LazyString columnName, LazyString originalColumnName, long length, int mysqlTypeId, short colFlag, int colDecimals, int collationIndex, String encoding, MysqlType mysqlType)

Field back to summary

Field	back to summary
public Field(String tableName, String columnName, int collationIndex, String encoding, MysqlType mysqlType, int length) Used by prepared statements to re-use result set data conversion methods when generating bound parameter retrieval instance for statement interceptors. Parameters tableName:String not used columnName:String not used collationIndex:int the MySQL collation/character set index encoding:String encoding of data in this field mysqlType:MysqlType `MysqlType` length:int length in characters or bytes (for BINARY data).

public Field(String tableName, String columnName, int collationIndex, String encoding, MysqlType mysqlType, int length)

Used by prepared statements to re-use result set data conversion methods when generating bound parameter retrieval instance for statement interceptors.

Parameters

tableName:String: not used
columnName:String: not used
collationIndex:int: the MySQL collation/character set index
encoding:String: encoding of data in this field
mysqlType:MysqlType: MysqlType
length:int: length in characters or bytes (for BINARY data).

Method Detail

adjustFlagsByMysqlType	back to summary
private void adjustFlagsByMysqlType()

getCollationIndex	back to summary
public int getCollationIndex()

getColumnLabel	back to summary
public String getColumnLabel()

getDatabaseName	back to summary
public String getDatabaseName()

getDecimals	back to summary
public int getDecimals()

getEncoding	back to summary
public String getEncoding() Returns the Java encoding for this field. Returns:String the Java encoding

getEncoding

back to summary

public String getEncoding()

Returns the Java encoding for this field.

Returns:String: the Java encoding

getFlags	back to summary
public short getFlags()

getFullName	back to summary
public String getFullName()

getJavaType	back to summary
public int getJavaType()

getLength	back to summary
public long getLength()

getMysqlType	back to summary
public MysqlType getMysqlType()

getMysqlTypeId	back to summary
public int getMysqlTypeId()

getName	back to summary
public String getName()

getOriginalName	back to summary
public String getOriginalName()

getOriginalTableName	back to summary
public String getOriginalTableName()

getTableName	back to summary
public String getTableName()

getValueNeedsQuoting	back to summary
public boolean getValueNeedsQuoting()

isAutoIncrement	back to summary
public boolean isAutoIncrement()

isBinary	back to summary
public boolean isBinary()

isBlob	back to summary
public boolean isBlob()

isFromFunction	back to summary
public boolean isFromFunction()

isMultipleKey	back to summary
public boolean isMultipleKey()

isNotNull	back to summary
public boolean isNotNull()

isPrimaryKey	back to summary
public boolean isPrimaryKey()

isReadOnly	back to summary
public boolean isReadOnly() Is this field _definitely_ not writable? Returns:boolean true if this field can not be written to in an INSERT/UPDATE statement.

isReadOnly

back to summary

public boolean isReadOnly()

Is this field _definitely_ not writable?

Returns:boolean: true if this field can not be written to in an INSERT/UPDATE statement.

isSingleBit	back to summary
public boolean isSingleBit()

isUniqueKey	back to summary
public boolean isUniqueKey()

isUnsigned	back to summary
public boolean isUnsigned()

isZeroFill	back to summary
public boolean isZeroFill()

setBinary	back to summary
public void setBinary()

setBlob	back to summary
public void setBlob()

setFlags	back to summary
public void setFlags(short colFlag)

setMysqlType	back to summary
public void setMysqlType(MysqlType mysqlType)

setMysqlTypeId	back to summary
public void setMysqlTypeId(int id)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations