Modifier and Type	Class and Description
public static class	StringClauses.ClauseIterator
public static class	StringClauses.Comment
public static class	StringClauses.Delimiter
public static interface	StringClauses.LiteralClause
public static class	StringClauses.Whitespace

Modifier and Type	Field and Description
private LinkedHashMap<String, Object>	clauses
private final String	end
private final Random	random
private final String	separator
private final String	start

Access	Constructor and Description
public	StringClauses() Creates a new StringClause with no start or end strings and a space separator.
public	StringClauses(String separator) Creates a new StringClause with no start or end strings and the given separator.
public	StringClauses(String start, String separator, String end) Creates a new StringClause with the given start, end and separator.

Method Summary

Modifier and Type	Method and Description
public StringClauses	append(String key, String clause) Adds a new clause at the end of the list with the given key.
public StringClauses	append(String key, StringClauses subclauses) Adds a new sub-clause at the end of the list with the given key.
public StringClauses	append(String clause) Adds a new clause at the end of the list.
public StringClauses	append(Enum<E extends Enum<E>> name, StringClauses subclauses) Convenience method for `append(String, StringClauses)` when using enums.
public StringClauses	append(Enum<E extends Enum<E>> name, String clause) Convenience method for `append(String, String)` when using enums.
public StringClauses	append(StringClauses.LiteralClause literal)
public boolean	contains(String key)
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	get(String exitingKey) Retrieves the given key.
public String	get(Enum<E extends Enum<E>> exitingKey) Convenience method for `get(String)` when using enums.
public StringClauses.ClauseIterator	getClauseIterator()
private Object	getImpl(String exitingKey)
public StringClauses	getSubclause(String exitingKey) Retrieves the given key.
public StringClauses	getSubclause(Enum<E extends Enum<E>> exitingKey) Convenience method for `getSubclause(String)` when using enums
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public StringClauses	insertAfter(String existingKey, String newKey, String newValue) Inserts a new clause after the given key.
public StringClauses	insertAfter(String existingKey, String newKey, StringClauses newValue) Inserts a new sub-clause after the given key.
public StringClauses	insertAfter(Enum<E extends Enum<E>> existingKey, String newValue) Convenience method for `insertAfter(String, String)` when using enums
public StringClauses	insertAfter(String existingKey, String newValue) Convenience method for `insertAfter(String, String, String)` using the newValue as the newKey.
private StringClauses	insertAfterImpl(String existingKey, String newKey, Object newValue)
public StringClauses	insertBefore(String existingKey, String newKey, String newValue) Inserts a new clause before the given key.
public StringClauses	insertBefore(String existingKey, String newKey, StringClauses newValue) Inserts a new sub-clause before the given key.
public StringClauses	insertBefore(String existingKey, String newValue) Convenience method for `insertBefore(String, String, String)` where the new clause key is equal to the newValue.
public StringClauses	insertBefore(Enum<E extends Enum<E>> existingKey, String newValue) Convenience method for `insertBefore(String, String)` when using enums.
public StringClauses	insertBefore(Enum<E extends Enum<E>> existingKey, Enum<E extends Enum<E>> newKey, String newValue) Convenience method for `insertBefore(String, String)` when using enums.
private StringClauses	insertBeforeImpl(String existingKey, String newKey, Object newValue)
public boolean	isEmpty()
public StringClauses	prepend(StringClauses.LiteralClause literal)
public StringClauses	prepend(String key, String clause) Adds a clause with the given key to the beginning of the list.
public StringClauses	prepend(String key, StringClauses clause) Adds a sub-clause with the given key to the beginning of the list.
public StringClauses	prepend(String clause) Convenience method for `prepend(String, String)` that uses the clause as the key.
public StringClauses	prepend(Enum<E extends Enum<E>> key, String clause) Convenience method for `prepend(String, String)` when using enums
public StringClauses	prepend(Enum<E extends Enum<E>> key, StringClauses clause) Convenience method for `prepend(String, liquibase.util.StringClauses)` when using enums
private StringClauses	prependImpl(String key, Object clause)
public StringClauses	remove(String key) Removes the clause with the given key.
public StringClauses	remove(Enum<E extends Enum<E>> key) Convenience method for `remove(String)` when using enums.
public StringClauses	replace(String key, String newValue) Replaces the given key with a new string.
public StringClauses	replace(String key, StringClauses newValue) Replaces the given key with a new sub-clause.
public StringClauses	replace(Enum<E extends Enum<E>> key, StringClauses newValue) Convenience method for `replace(String, liquibase.util.StringClauses)` when using enums.
public StringClauses	replace(Enum<E extends Enum<E>> key, String newValue) Convenience method for `replace(String, String)` when using enums.
private StringClauses	replaceImpl(String key, Object newValue)
public Object[]	toArray(boolean stringify)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private String	uniqueKey(String key) Returns the key if it is not empty and/or not already used.

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

Field Detail

clauses	back to summary
private LinkedHashMap<String, Object> clauses

end	back to summary
private final String end

random	back to summary
private final Random random

separator	back to summary
private final String separator

start	back to summary
private final String start

Constructor Detail

StringClauses	back to summary
public StringClauses() Creates a new StringClause with no start or end strings and a space separator.

StringClauses	back to summary
public StringClauses(String separator) Creates a new StringClause with no start or end strings and the given separator.

StringClauses	back to summary
public StringClauses(String start, String separator, String end) Creates a new StringClause with the given start, end and separator.

Method Detail

append	back to summary
public StringClauses append(String key, String clause) Adds a new clause at the end of the list with the given key.

append	back to summary
public StringClauses append(String key, StringClauses subclauses) Adds a new sub-clause at the end of the list with the given key.

append	back to summary
public StringClauses append(String clause) Adds a new clause at the end of the list. The key is equal to the passed clause. There is no corresponding append with just a StringClauses because the subclause may not be fully created when appended and so the key may be an unexpected value.

append	back to summary
public StringClauses append(Enum<E extends Enum<E>> name, StringClauses subclauses) Convenience method for `append(String, StringClauses)` when using enums.

append	back to summary
public StringClauses append(Enum<E extends Enum<E>> name, String clause) Convenience method for `append(String, String)` when using enums.

append	back to summary
public StringClauses append(StringClauses.LiteralClause literal)

contains	back to summary
public boolean contains(String key)

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

get	back to summary
public String get(String exitingKey) Retrieves the given key. Returns null if not set. If clause at key is a StringClause, return the string version of it. Will traverse sub-clauses to find the key.

get	back to summary
public String get(Enum<E extends Enum<E>> exitingKey) Convenience method for `get(String)` when using enums.

getClauseIterator	back to summary
public StringClauses.ClauseIterator getClauseIterator()

getImpl	back to summary
private Object getImpl(String exitingKey)

getSubclause	back to summary
public StringClauses getSubclause(String exitingKey) Retrieves the given key. Returns null if not set. If clause at key is a String, return a new StringClause version of it. Will traverse sub-clauses to find the key.

getSubclause	back to summary
public StringClauses getSubclause(Enum<E extends Enum<E>> exitingKey) Convenience method for `getSubclause(String)` when using enums

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 this 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 this 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

insertAfter	back to summary
public StringClauses insertAfter(String existingKey, String newKey, String newValue) Inserts a new clause after the given key. Throws IllegalArgumentException if the existingKey does not exist.

insertAfter	back to summary
public StringClauses insertAfter(String existingKey, String newKey, StringClauses newValue) Inserts a new sub-clause after the given key. Throws IllegalArgumentException if the existingKey does not exist.

insertAfter	back to summary
public StringClauses insertAfter(Enum<E extends Enum<E>> existingKey, String newValue) Convenience method for `insertAfter(String, String)` when using enums

insertAfter	back to summary
public StringClauses insertAfter(String existingKey, String newValue) Convenience method for `insertAfter(String, String, String)` using the newValue as the newKey.

insertAfterImpl	back to summary
private StringClauses insertAfterImpl(String existingKey, String newKey, Object newValue)

insertBefore	back to summary
public StringClauses insertBefore(String existingKey, String newKey, String newValue) throws IllegalArgumentException Inserts a new clause before the given key. Throws IllegalArgumentException if the existingKey does not exist.

insertBefore	back to summary
public StringClauses insertBefore(String existingKey, String newKey, StringClauses newValue) Inserts a new sub-clause before the given key. Throws IllegalArgumentException if the existingKey does not exist.

insertBefore	back to summary
public StringClauses insertBefore(String existingKey, String newValue) Convenience method for `insertBefore(String, String, String)` where the new clause key is equal to the newValue.

insertBefore	back to summary
public StringClauses insertBefore(Enum<E extends Enum<E>> existingKey, String newValue) Convenience method for `insertBefore(String, String)` when using enums.

insertBefore	back to summary
public StringClauses insertBefore(Enum<E extends Enum<E>> existingKey, Enum<E extends Enum<E>> newKey, String newValue) Convenience method for `insertBefore(String, String)` when using enums.

insertBeforeImpl	back to summary
private StringClauses insertBeforeImpl(String existingKey, String newKey, Object newValue)

isEmpty	back to summary
public boolean isEmpty()

prepend	back to summary
public StringClauses prepend(StringClauses.LiteralClause literal)

prepend	back to summary
public StringClauses prepend(String key, String clause) Adds a clause with the given key to the beginning of the list.

prepend	back to summary
public StringClauses prepend(String key, StringClauses clause) Adds a sub-clause with the given key to the beginning of the list.

prepend	back to summary
public StringClauses prepend(String clause) Convenience method for `prepend(String, String)` that uses the clause as the key.

prepend	back to summary
public StringClauses prepend(Enum<E extends Enum<E>> key, String clause) Convenience method for `prepend(String, String)` when using enums

prepend	back to summary
public StringClauses prepend(Enum<E extends Enum<E>> key, StringClauses clause) Convenience method for `prepend(String, liquibase.util.StringClauses)` when using enums

prependImpl	back to summary
private StringClauses prependImpl(String key, Object clause) throws IllegalArgumentException

remove	back to summary
public StringClauses remove(String key) Removes the clause with the given key. Removes case insensitively. If key doesn't exist, operation is a no-op.

remove	back to summary
public StringClauses remove(Enum<E extends Enum<E>> key) Convenience method for `remove(String)` when using enums.

replace	back to summary
public StringClauses replace(String key, String newValue) throws IllegalArgumentException Replaces the given key with a new string. If the existing key does not exist, throws IllegalArgumentException

replace	back to summary
public StringClauses replace(String key, StringClauses newValue) Replaces the given key with a new sub-clause. If the existing key does not exist, throws IllegalArgumentException

replace	back to summary
public StringClauses replace(Enum<E extends Enum<E>> key, StringClauses newValue) Convenience method for `replace(String, liquibase.util.StringClauses)` when using enums.

replace	back to summary
public StringClauses replace(Enum<E extends Enum<E>> key, String newValue) Convenience method for `replace(String, String)` when using enums.

replaceImpl	back to summary
private StringClauses replaceImpl(String key, Object newValue)

toArray	back to summary
public Object[] toArray(boolean stringify)

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

@Override

uniqueKey	back to summary
private String uniqueKey(String key) Returns the key if it is not empty and/or not already used. If it is already used, it generates a random value for the key.

liquibase.util back to summary

public Class StringClauses.ClauseIterator

Class Inheritance

extends Object
implements Iterator

java.lang.Object
liquibase.util.StringClauses.ClauseIterator

All Implemented Interfaces

java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private final LinkedHashMap<String, Object>	clauses
private final ListIterator<String>	keyIterator

Constructor Summary

Access	Constructor and Description
public	ClauseIterator(LinkedHashMap<String, Object> clauses)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Object	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public Object	nextNonWhitespace()
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).
public void	replace(Object newClause)

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

Field Detail

clauses	back to summary
private final LinkedHashMap<String, Object> clauses

keyIterator	back to summary
private final ListIterator<String> keyIterator

Constructor Detail

ClauseIterator	back to summary
public ClauseIterator(LinkedHashMap<String, Object> clauses)

Method Detail

hasNext back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

back to summary

public Object next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Object

the next element in the iteration

Annotations

@Override

nextNonWhitespace	back to summary
public Object nextNonWhitespace()

remove back to summary

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

replace	back to summary
public void replace(Object newClause)

public Class StringClauses

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class StringClauses.ClauseIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class StringClauses.Comment

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class StringClauses.Delimiter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface StringClauses.LiteralClause

Method Summary

Method Detail

public Class StringClauses.Whitespace

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail