com.amazon.carbonado.qe

Class QueryHints

java.lang.Object

com.amazon.carbonado.qe.QueryHints

All Implemented Interfaces:

java.io.Serializable

public class QueryHints
extends java.lang.Object
implements java.io.Serializable

An immutable map of query hints.

Since:

1.2

Author:

Brian S O'Neill

See Also:

QueryHint, Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(QueryHint hint) Returns false if hint is not provided.
static QueryHints	emptyHints()
boolean	equals(java.lang.Object obj)
java.lang.Object	get(QueryHint hint) Returns null if hint is not provided.
int	hashCode()
boolean	isEmpty()
java.lang.String	toString()
QueryHints	with(QueryHint hint) Returns a new QueryHints object with the given hint.
QueryHints	with(QueryHint hint, java.lang.Object value) Returns a new QueryHints object with the given hint and value.
QueryHints	without(QueryHint hint) Returns a new QueryHints object without the given hint.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

emptyHints

public static QueryHints emptyHints()

with

public QueryHints with(QueryHint hint)

Returns a new QueryHints object with the given hint. The associated value is the hint object itself.

Throws:

java.lang.IllegalArgumentException - if hint is null

with

public QueryHints with(QueryHint hint,
              java.lang.Object value)

Returns a new QueryHints object with the given hint and value.

Throws:

java.lang.IllegalArgumentException - if hint or value is null

without

public QueryHints without(QueryHint hint)

Returns a new QueryHints object without the given hint.

contains

public boolean contains(QueryHint hint)

Returns false if hint is not provided.

get

public java.lang.Object get(QueryHint hint)

Returns null if hint is not provided.

isEmpty

public boolean isEmpty()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object