MapKeyColumn (hibernate-jpamodelgen JavaDocs)

java.lang.Object
- org.hibernate.jpamodelgen.xml.jaxb.MapKeyColumn

```
public class MapKeyColumn
extends Object
```
@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface MapKeyColumn { String name() default ""; boolean unique() default false; boolean nullable() default false; boolean insertable() default true; boolean updatable() default true; String columnDefinition() default ""; String table() default ""; int length() default 255; int precision() default 0; // decimal precision int scale() default 0; // decimal scale }

<p>Java class for map-key-column complex type.

<p>The following schema fragment specifies the expected content contained within this class.

<pre> <complexType name="map-key-column"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="unique" type="{http://www.w3.org/2001/XMLSchema}boolean" /> <attribute name="nullable" type="{http://www.w3.org/2001/XMLSchema}boolean" /> <attribute name="insertable" type="{http://www.w3.org/2001/XMLSchema}boolean" /> <attribute name="updatable" type="{http://www.w3.org/2001/XMLSchema}boolean" /> <attribute name="column-definition" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="table" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="length" type="{http://www.w3.org/2001/XMLSchema}int" /> <attribute name="precision" type="{http://www.w3.org/2001/XMLSchema}int" /> <attribute name="scale" type="{http://www.w3.org/2001/XMLSchema}int" /> </restriction> </complexContent> </complexType> </pre>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`columnDefinition`
`protected Boolean`	`insertable`
`protected Integer`	`length`
`protected String`	`name`
`protected Boolean`	`nullable`
`protected Integer`	`precision`
`protected Integer`	`scale`
`protected String`	`table`
`protected Boolean`	`unique`
`protected Boolean`	`updatable`

Constructor Summary

Constructors
Constructor and Description

MapKeyColumn()

Constructors
Constructor and Description
`MapKeyColumn()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getColumnDefinition()` Gets the value of the columnDefinition property.
`Integer`	`getLength()` Gets the value of the length property.
`String`	`getName()` Gets the value of the name property.
`Integer`	`getPrecision()` Gets the value of the precision property.
`Integer`	`getScale()` Gets the value of the scale property.
`String`	`getTable()` Gets the value of the table property.
`Boolean`	`isInsertable()` Gets the value of the insertable property.
`Boolean`	`isNullable()` Gets the value of the nullable property.
`Boolean`	`isUnique()` Gets the value of the unique property.
`Boolean`	`isUpdatable()` Gets the value of the updatable property.
`void`	`setColumnDefinition(String value)` Sets the value of the columnDefinition property.
`void`	`setInsertable(Boolean value)` Sets the value of the insertable property.
`void`	`setLength(Integer value)` Sets the value of the length property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setNullable(Boolean value)` Sets the value of the nullable property.
`void`	`setPrecision(Integer value)` Sets the value of the precision property.
`void`	`setScale(Integer value)` Sets the value of the scale property.
`void`	`setTable(String value)` Sets the value of the table property.
`void`	`setUnique(Boolean value)` Sets the value of the unique property.
`void`	`setUpdatable(Boolean value)` Sets the value of the updatable property.

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

- Field Detail
  - name
```
protected String name
```
  - unique
```
protected Boolean unique
```
  - nullable
```
protected Boolean nullable
```
  - insertable
```
protected Boolean insertable
```
  - updatable
```
protected Boolean updatable
```
  - columnDefinition
```
protected String columnDefinition
```
  - table
```
protected String table
```
  - length
```
protected Integer length
```
  - precision
```
protected Integer precision
```
  - scale
```
protected Integer scale
```
- Constructor Detail
  - MapKeyColumn
```
public MapKeyColumn()
```
- Method Detail
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - isUnique
```
public Boolean isUnique()
```
    Gets the value of the unique property.
    
    Returns:
    
    possible object is Boolean
  - setUnique
```
public void setUnique(Boolean value)
```
    Sets the value of the unique property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isNullable
```
public Boolean isNullable()
```
    Gets the value of the nullable property.
    
    Returns:
    
    possible object is Boolean
  - setNullable
```
public void setNullable(Boolean value)
```
    Sets the value of the nullable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isInsertable
```
public Boolean isInsertable()
```
    Gets the value of the insertable property.
    
    Returns:
    
    possible object is Boolean
  - setInsertable
```
public void setInsertable(Boolean value)
```
    Sets the value of the insertable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isUpdatable
```
public Boolean isUpdatable()
```
    Gets the value of the updatable property.
    
    Returns:
    
    possible object is Boolean
  - setUpdatable
```
public void setUpdatable(Boolean value)
```
    Sets the value of the updatable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getColumnDefinition
```
public String getColumnDefinition()
```
    Gets the value of the columnDefinition property.
    
    Returns:
    
    possible object is String
  - setColumnDefinition
```
public void setColumnDefinition(String value)
```
    Sets the value of the columnDefinition property.
    
    Parameters:
    
    value - allowed object is String
  - getTable
```
public String getTable()
```
    Gets the value of the table property.
    
    Returns:
    
    possible object is String
  - setTable
```
public void setTable(String value)
```
    Sets the value of the table property.
    
    Parameters:
    
    value - allowed object is String
  - getLength
```
public Integer getLength()
```
    Gets the value of the length property.
    
    Returns:
    
    possible object is Integer
  - setLength
```
public void setLength(Integer value)
```
    Sets the value of the length property.
    
    Parameters:
    
    value - allowed object is Integer
  - getPrecision
```
public Integer getPrecision()
```
    Gets the value of the precision property.
    
    Returns:
    
    possible object is Integer
  - setPrecision
```
public void setPrecision(Integer value)
```
    Sets the value of the precision property.
    
    Parameters:
    
    value - allowed object is Integer
  - getScale
```
public Integer getScale()
```
    Gets the value of the scale property.
    
    Returns:
    
    possible object is Integer
  - setScale
```
public void setScale(Integer value)
```
    Sets the value of the scale property.
    
    Parameters:
    
    value - allowed object is Integer

Class MapKeyColumn

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

unique

nullable

insertable

updatable

columnDefinition

table

length

precision

scale

Constructor Detail

MapKeyColumn

Method Detail

getName

setName

isUnique

setUnique

isNullable

setNullable

isInsertable

setInsertable

isUpdatable

setUpdatable

getColumnDefinition

setColumnDefinition

getTable

setTable

getLength

setLength

getPrecision

setPrecision

getScale

setScale