Interface PrimordialDomain

All Known Subinterfaces:

Domain

All Known Implementing Classes:

DefaultDomain

public interface PrimordialDomain

A view of an underlying domain of valid Java constructs that exposes the null type, various kinds of pseudo-types, the prototypical java.lang.Object type, and the ability to globally lock for symbol completion if needed.

PrimordialDomains are primordial because they expose the "first principles" constructs needed to compose other constructs.

Author:

Laird Nelson

See Also:

• javaLangObjectType()
• lock()
• noType(TypeKind)
• nullType()

Method Summary

Modifier and Type	Method	Description
DeclaredType	javaLangObjectType()	Returns the (non-null, determinate) DeclaredType representing the prototypical type of java.lang.Object.
Unlockable	lock()	Semantically locks an opaque lock used to serialize symbol completion, and returns it in the form of an Unlockable.
NoType	noType(TypeKind kind)	Returns a (non-null, determinate) NoType representing the supplied TypeKind, provided it is either TypeKind.NONE or TypeKind.VOID.
NullType	nullType()	Returns a (non-null, determinate) NullType representing the null type.
default String	toString(CharSequence name)	A convenience method that converts the supplied CharSequence, which is often a Name, into a String, and returns the conversion, locking when appropriate to serialize symbol completion.

Method Details

javaLangObjectType

DeclaredType javaLangObjectType()

Returns the (non-null, determinate) DeclaredType representing the prototypical type of java.lang.Object.

Implementations of this method must not return null.

DeclaredType instances returned by implementations of this method must return TypeKind.DECLARED from their TypeMirror.getKind() method.

Returns:

the DeclaredType representing the prototypical type of java.lang.Object; never null

lock

Unlockable lock()

Semantically locks an opaque lock used to serialize symbol completion, and returns it in the form of an Unlockable.

Implementations of this method must not return null.

Returns:

an Unlockable in a semantically locked state; never null

See Also:

• SymbolCompletionLock
• Unlockable.close()

noType

NoType noType(TypeKind kind)

Returns a (non-null, determinate) NoType representing the supplied TypeKind, provided it is either TypeKind.NONE or TypeKind.VOID.

Implementations of this method must not return null.

Parameters:

kind - a TypeKind; must be either TypeKind.NONE or TypeKind.VOID

Returns:

a NoType representing the supplied TypeKind; never null

Throws:

NullPointerException - if kind is null

IllegalArgumentException - if kind is neither TypeKind.NONE nor TypeKind.VOID

See Also:

• Types.getNoType(TypeKind)

nullType

NullType nullType()

Returns a (non-null, determinate) NullType representing the null type.

Implementations of thsi method must not return null.

Returns:

a NullType representing the null type; never null

See Also:

• Types.getNullType()

toString

default String toString(CharSequence name)

A convenience method that converts the supplied CharSequence, which is often a Name, into a String, and returns the conversion, locking when appropriate to serialize symbol completion.

The default implementation of this method may return null if the supplied name is null.

In many implementations of domains, converting a Name to a String can cause problems if symbol completion is taking place concurrently and the symbol completion lock is not held. This method helps avoid those problems.

Overriding this method is not normally needed.

Parameters:

name - the CharSequence to convert; may be null in which case null will be returned

Returns:

a String, or null if name was null

See Also:

• lock()
• Name