@DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=FIELD) @DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=PARAMETER) @DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=RETURN)

Package org.apache.calcite.util

Provides utility classes.

See: Description

Interface Summary

Interface	Description
CalciteParserException	Tagging interface to allow a SqlParseException to be identified without adding a dependency on it from client-side code.
CalciteValidatorException	Tagging interface to allow a SqlValidatorException to be identified without adding a dependency on it from client-side code.
Compatible	Compatibility layer.
Glossary	A collection of terms.
JdbcType<T>	Maps Java types to their corresponding getters in JDBC.
Litmus	Callback to be called when a test for validity succeeds or fails.
PartiallyOrderedSet.Ordering<E>	Ordering relation.
PrecedenceClimbingParser.Special	Callback defining the behavior of a special function.
RangeSets.Consumer<C extends Comparable<C>>	Consumer of Range values.
RangeSets.Handler<C extends Comparable<C>,R>	Deconstructor for Range values.
ReflectiveVisitDispatcher<R extends ReflectiveVisitor,E>	Interface for looking up methods relating to reflective visitation.
ReflectiveVisitor	Object which can be a target for a reflective visitation (see ReflectUtil.invokeVisitor(ReflectiveVisitor, Object, Class, String).
ReflectUtil.MethodDispatcher<T>	Can invoke a method on an object of type E with return type T.
SaffronProperties	Deprecated As of release 1.19, replaced by CalciteSystemProperty
Source	Source of data.
TryThreadLocal.Memo	Remembers to set the value back.

Class Summary

Class	Description
BarfingInvocationHandler	A class derived from BarfingInvocationHandler handles a method call by looking for a method in itself with identical parameters.
Benchmark	Helps to run benchmarks by running the same task repeatedly and averaging the running times.
Benchmark.Statistician	Collects statistics for a test that is run multiple times.
BitSets	Utility functions for BitSet.
BitString	String of bits.
Bug	Holder for a list of constants describing which bugs which have not been fixed.
CancelFlag	CancelFlag is used to post and check cancellation requests.
CastingList<E>	Converts a list whose members are automatically down-cast to a given type.
ChunkList<E>	Implementation of list similar to LinkedList, but stores elements in chunks of 32 elements.
Closer	Helper that holds onto AutoCloseable resources and releases them when its #close method is called.
Compatible.Factory	Creates the implementation of Compatible suitable for the current environment.
CompositeList<T>	Read-only list that is the concatenation of sub-lists.
CompositeMap<K,V>	Unmodifiable view onto multiple backing maps.
ConversionUtil	Utility functions for converting from one type to another.
DateString	Date literal.
DateTimeStringUtils	Utility methods to manipulate String representation of DateTime values.
DelegatingInvocationHandler	A class derived from DelegatingInvocationHandler handles a method call by looking for a method in itself with identical parameters.
EquivalenceSet<E extends Comparable<E>>	Set of elements organized into equivalence classes.
Filterator<E>	Filtered iterator class: an iterator that includes only elements that are instanceof a specified class.
Holder<E>	A mutable slot that can contain one object.
ImmutableBitSet	An immutable list of bits.
ImmutableBitSet.Builder	Builder.
ImmutableIntList	An immutable list of Integer values backed by an array of ints.
ImmutableNullableList<E>	An immutable list that may contain null values.
ImmutableNullableList.Builder<E>	A builder for creating immutable nullable list instances.
ImmutableNullableMap<K,V>	An immutable map that may contain null values.
ImmutableNullableSet<E>	An immutable set that may contain null values.
ImmutableNullableSet.Builder<E>	A builder for creating immutable nullable set instances.
IntegerIntervalSet	A set of non-negative integers defined by a sequence of points, intervals, and exclusions.
IntList	Deprecated
JsonBuilder	Builder for JSON documents (represented as List, Map, String, Boolean, Long).
NameMap<V>	Map whose keys are names and can be accessed with and without case sensitivity.
NameMultimap<V>	Multimap whose keys are names and can be accessed with and without case sensitivity.
NameSet	Set of names that can be accessed with and without case sensitivity.
NlsString	A string, optionally with character set and SqlCollation.
NumberUtil	Utility functions for working with numbers.
Pair<T1,T2>	Pair of objects.
PartiallyOrderedSet<E>	Partially-ordered set.
Permutation	Represents a mapping which reorders elements in an array.
PrecedenceClimbingParser	Parser that takes a collection of tokens (atoms and operators) and groups them together according to the operators' precedence and associativity.
PrecedenceClimbingParser.Builder	Fluent helper to build a parser containing a list of tokens.
PrecedenceClimbingParser.Call	A token that is a call to an operator with arguments.
PrecedenceClimbingParser.Op	An operator token.
PrecedenceClimbingParser.Result	Result of a call to PrecedenceClimbingParser.Special.apply(org.apache.calcite.util.PrecedenceClimbingParser, org.apache.calcite.util.PrecedenceClimbingParser.SpecialOp).
PrecedenceClimbingParser.SpecialOp	An token corresponding to a special operator.
PrecedenceClimbingParser.Token	A token: either an atom, a call to an operator with arguments, or an unmatched operator.
RangeSets	Utilities for Guava RangeSet.
ReflectUtil	Static utilities for Java reflection.
RelToSqlConverterUtil	Utilities used by multiple dialect for RelToSql conversion.
SaffronProperties.Helper	Helper class.
Sarg<C extends Comparable<C>>	Set of values (or ranges) that are the target of a search.
SerializableCharset	Serializable wrapper around a Charset.
SimpleNamespaceContext	Simple NamespaceContext implementation.
Sources	Utilities for Source.
SourceStringReader	Extension to StringReader that allows the original string to be recovered.
Stacks	Deprecated
StackWriter	A helper class for generating formatted text.
Static	Definitions of objects to be statically imported.
Template	String template.
TimestampString	Timestamp literal.
TimestampWithTimeZoneString	Timestamp with time-zone literal.
TimeString	Time literal.
TimeWithTimeZoneString	Time with time-zone literal.
TryThreadLocal<T>	Thread-local variable that returns a handle that can be closed.
UnmodifiableArrayList<E>	A view onto an array that cannot be modified by the client.
Unsafe	Contains methods that call JDK methods that the forbidden APIs checker does not approve of.
Util	Miscellaneous utility functions.
Util.OverFinder	Visitor which looks for an OVER clause inside a tree of SqlNode objects.
XmlOutput	Streaming XML output.

Enum Summary

Enum	Description
BuiltInMethod	Built-in methods.
Optionality	Four states that describe whether a particular behavior or property is allowed and/or not allowed.
PrecedenceClimbingParser.Type	Token type.

Exception Summary

Exception	Description
ControlFlowException	Exception intended to be used for control flow, as opposed to the usual use of exceptions which is to signal an error condition.
Util.FoundOne	Exception used to interrupt a tree walk of any kind.

Package org.apache.calcite.util Description

Provides utility classes.