Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.boot.model.naming.Identifier

Modifier and Type	Field and Description
private final boolean	isQuoted
private final String	text

Access	Constructor and Description
public	Identifier(String The identifier text. text, boolean Is this a quoted identifier? quoted) Constructs an identifier instance.
protected	Identifier(String The identifier text. text) Constructs an unquoted identifier instance.

Method Summary

Modifier and Type	Method and Description
public static boolean	areEqual(Identifier id1, Identifier id2)
public int	compareTo(Identifier the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getCanonicalName()
public String	Returns: The name getText() Get the identifiers name (text)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public static boolean	Returns: `true` if the given identifier text is considered quoted; `false` otherwise. isQuoted(String name) Is the given identifier text considered quoted.
public static boolean	isQuoted(String name, int start, int end)
public boolean	Returns: True if this is a quote identifier; false otherwise. isQuoted() Is this a quoted identifier?
public boolean	matches(String name)
public static Identifier	quote(Identifier identifier)
public String	Returns: if quoted, identifier name enclosed in dialect-specific open- and end-quotes; otherwise, the unquoted identifier. render(Dialect The dialect whose dialect-specific quoting should be used. dialect) If this is a quoted identifier, then return the identifier name enclosed in dialect-specific open- and end-quotes; otherwise, simply return the unquoted identifier.
public String	render()
public static Identifier	Returns: The identifier form, or `null` if text was `null` toIdentifier(String The text form text) Means to generate an `Identifier` instance from its simple text form.
public static Identifier	Returns: The identifier form, or `null` if text was `null` toIdentifier(String The text form text, boolean Whether to quote unquoted text forms quote) Means to generate an `Identifier` instance from its simple text form.
public static Identifier	Returns: The identifier form, or `null` if text was `null` toIdentifier(String The text form text, boolean Whether to quote unquoted text forms quote, boolean Controls whether to treat the result as quoted if text contains characters that are invalid for identifiers quoteOnNonIdentifierChar) Means to generate an `Identifier` instance from its simple text form.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static String	unQuote(String name)

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

isQuoted	back to summary
private final boolean isQuoted

text	back to summary
private final String text

Identifier	back to summary
public Identifier(String text, boolean quoted) Constructs an identifier instance. Parameters text:String The identifier text. quoted:boolean Is this a quoted identifier?

Identifier	back to summary
protected Identifier(String text) Constructs an unquoted identifier instance. Parameters text:String The identifier text.

Method Detail

areEqual	back to summary
public static boolean areEqual(Identifier id1, Identifier id2)

compareTo back to summary

compareTo	back to summary
public int compareTo(Identifier o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:Identifier the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(Identifier o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:Identifier: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getCanonicalName	back to summary
public String getCanonicalName()

getText	back to summary
public String getText() Get the identifiers name (text) Returns:String The name

getText

back to summary

public String getText()

Get the identifiers name (text)

Returns:String: The name

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isQuoted back to summary

isQuoted	back to summary
public static boolean isQuoted(String name) Is the given identifier text considered quoted. The following patterns are recognized as quoted: `name` `[name]` `"name"` That final form using double-quote (") is the JPA-defined quoting pattern. Although it is the standard, it makes for ugly declarations. Returns:boolean `true` if the given identifier text is considered quoted; `false` otherwise.

public static boolean isQuoted(String name)

Is the given identifier text considered quoted. The following patterns are recognized as quoted:

`name`
[name]
"name"

That final form using double-quote (") is the JPA-defined quoting pattern. Although it is the standard, it makes for ugly declarations.

Returns:boolean: true if the given identifier text is considered quoted; false otherwise.

isQuoted	back to summary
public static boolean isQuoted(String name, int start, int end)

isQuoted	back to summary
public boolean isQuoted() Is this a quoted identifier? Returns:boolean True if this is a quote identifier; false otherwise.

isQuoted

back to summary

public boolean isQuoted()

Is this a quoted identifier?

Returns:boolean: True if this is a quote identifier; false otherwise.

matches	back to summary
public boolean matches(String name)

quote	back to summary
public static Identifier quote(Identifier identifier)

render	back to summary
public String render(Dialect dialect) If this is a quoted identifier, then return the identifier name enclosed in dialect-specific open- and end-quotes; otherwise, simply return the unquoted identifier. Parameters dialect:Dialect The dialect whose dialect-specific quoting should be used. Returns:String if quoted, identifier name enclosed in dialect-specific open- and end-quotes; otherwise, the unquoted identifier.

render

back to summary

public String render(Dialect dialect)

If this is a quoted identifier, then return the identifier name enclosed in dialect-specific open- and end-quotes; otherwise, simply return the unquoted identifier.

Parameters

dialect:Dialect: The dialect whose dialect-specific quoting should be used.

Returns:String

if quoted, identifier name enclosed in dialect-specific open- and end-quotes; otherwise, the unquoted identifier.

render	back to summary
public String render()

toIdentifier back to summary

toIdentifier	back to summary
public static Identifier toIdentifier(String text) Means to generate an `Identifier` instance from its simple text form. If passed text is `null`, `null` is returned. If passed text is surrounded in quote markers, the generated Identifier is considered quoted. Quote markers include back-ticks (`), double-quotes (") and brackets ([ and ]). If the text, after trimming, contains a character that is not a valid identifier character, the identifier is treated as quoted. Parameters text:String The text form Returns:Identifier The identifier form, or `null` if text was `null`

public static Identifier toIdentifier(String text)

Means to generate an Identifier instance from its simple text form.

If passed text is null, null is returned.

If passed text is surrounded in quote markers, the generated Identifier is considered quoted. Quote markers include back-ticks (`), double-quotes (") and brackets ([ and ]). If the text, after trimming, contains a character that is not a valid identifier character, the identifier is treated as quoted.

Parameters

text:String: The text form

Returns:Identifier

The identifier form, or null if text was null

toIdentifier back to summary

toIdentifier	back to summary
public static Identifier toIdentifier(String text, boolean quote) Means to generate an `Identifier` instance from its simple text form. If passed text is `null`, `null` is returned. If passed text is surrounded in quote markers, the generated Identifier is considered quoted. Quote markers include back-ticks (`), double-quotes (") and brackets ([ and ]). If the text, after trimming, contains a character that is not a valid identifier character, the identifier is treated as quoted. Parameters text:String The text form quote:boolean Whether to quote unquoted text forms Returns:Identifier The identifier form, or `null` if text was `null`

public static Identifier toIdentifier(String text, boolean quote)

Means to generate an Identifier instance from its simple text form.

If passed text is null, null is returned.

Parameters

text:String: The text form
quote:boolean: Whether to quote unquoted text forms

Returns:Identifier

The identifier form, or null if text was null

toIdentifier back to summary

toIdentifier	back to summary
public static Identifier toIdentifier(String text, boolean quote, boolean quoteOnNonIdentifierChar) Means to generate an `Identifier` instance from its simple text form. If passed text is `null`, `null` is returned. If passed text is surrounded in quote markers, the generated Identifier is considered quoted. Quote markers include back-ticks (`), double-quotes (") and brackets ([ and ]). Parameters text:String The text form quote:boolean Whether to quote unquoted text forms quoteOnNonIdentifierChar:boolean Controls whether to treat the result as quoted if text contains characters that are invalid for identifiers Returns:Identifier The identifier form, or `null` if text was `null`

public static Identifier toIdentifier(String text, boolean quote, boolean quoteOnNonIdentifierChar)

Means to generate an Identifier instance from its simple text form.

If passed text is null, null is returned.

If passed text is surrounded in quote markers, the generated Identifier is considered quoted. Quote markers include back-ticks (`), double-quotes (") and brackets ([ and ]).

Parameters

text:String: The text form
quote:boolean: Whether to quote unquoted text forms
quoteOnNonIdentifierChar:boolean: Controls whether to treat the result as quoted if text contains characters that are invalid for identifiers

Returns:Identifier

The identifier form, or null if text was null

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. Returns:String a string representation of the object. Annotations @Override

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.

Returns:String

a string representation of the object.

Annotations

@Override

unQuote	back to summary
public static String unQuote(String name)

public Class Identifier

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail