Package org.pkl.core

Class PClass

java.lang.Object

org.pkl.core.Member

org.pkl.core.PClass

All Implemented Interfaces:

java.io.Serializable, Value

public final class PClass
extends Member
implements Value

Java representation of a pkl.base#Class value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PClass.ClassMember
static class	PClass.Method
static class	PClass.Property

Nested classes/interfaces inherited from class org.pkl.core.Member

Member.SourceLocation

Constructor Summary

Constructors

Constructor	Description
PClass(@Nullable java.lang.String docComment, Member.SourceLocation sourceLocation, java.util.Set<Modifier> modifiers, java.util.List<PObject> annotations, PClassInfo<?> classInfo, java.util.List<TypeParameter> typeParameters, java.util.Map<java.lang.String,PClass.Property> properties, java.util.Map<java.lang.String,PClass.Method> methods)

Method Summary

Modifier and Type	Method	Description
<T> T	accept(ValueConverter<T> converter)	Invokes the given converters's convert method for this Value.
void	accept(ValueVisitor visitor)	Invokes the given visitor's visit method for this Value.
java.util.Map<java.lang.String,PClass.Method>	getAllMethods()
java.util.Map<java.lang.String,PClass.Property>	getAllProperties()
PClassInfo<?>	getClassInfo()	Returns information about the Pkl class associated with this Value.
java.lang.String	getDisplayName()
PClassInfo<?>	getInfo()
java.util.Map<java.lang.String,PClass.Method>	getMethods()
java.lang.String	getModuleName()	Returns the name of the module that this class is declared in.
java.util.Map<java.lang.String,PClass.Property>	getProperties()
java.lang.String	getQualifiedName()	Returns the qualified name of this class, `moduleName#className`.
@Nullable PClass	getSuperclass()
@Nullable PType	getSupertype()
java.util.List<TypeParameter>	getTypeParameters()
void	initSupertype(PType supertype, PClass superclass)
boolean	isModuleClass()	Tells if this class is the class of a module.
java.lang.String	toString()

Methods inherited from class org.pkl.core.Member

getAnnotations, getDocComment, getModifiers, getSimpleName, getSourceLocation, isAbstract, isExternal, isHidden, isOpen, isStandardLibraryMember

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PClass

public PClass(@Nullable java.lang.String docComment,
              Member.SourceLocation sourceLocation,
              java.util.Set<Modifier> modifiers,
              java.util.List<PObject> annotations,
              PClassInfo<?> classInfo,
              java.util.List<TypeParameter> typeParameters,
              java.util.Map<java.lang.String,PClass.Property> properties,
              java.util.Map<java.lang.String,PClass.Method> methods)

Method Detail

initSupertype

public void initSupertype(PType supertype,
                          PClass superclass)

getModuleName

public java.lang.String getModuleName()

Returns the name of the module that this class is declared in. Note that a module name is not guaranteed to be unique, especially if it not declared but inferred from the module URI.

Specified by:

getModuleName in class Member

getQualifiedName

public java.lang.String getQualifiedName()

Returns the qualified name of this class, `moduleName#className`. Note that a qualified class name is not guaranteed to be unique, especially if the module name is not declared but inferred from the module URI.

getDisplayName

public java.lang.String getDisplayName()

getInfo

public PClassInfo<?> getInfo()

isModuleClass

public boolean isModuleClass()

Tells if this class is the class of a module.

getTypeParameters

public java.util.List<TypeParameter> getTypeParameters()

getSupertype

public @Nullable PType getSupertype()

getSuperclass

public @Nullable PClass getSuperclass()

getProperties

public java.util.Map<java.lang.String,PClass.Property> getProperties()

getMethods

public java.util.Map<java.lang.String,PClass.Method> getMethods()

getAllProperties

public java.util.Map<java.lang.String,PClass.Property> getAllProperties()

getAllMethods

public java.util.Map<java.lang.String,PClass.Method> getAllMethods()

accept

public void accept(ValueVisitor visitor)

Description copied from interface: Value

Invokes the given visitor's visit method for this Value.

Specified by:

accept in interface Value

accept

public <T> T accept(ValueConverter<T> converter)

Description copied from interface: Value

Invokes the given converters's convert method for this Value.

Specified by:

accept in interface Value

getClassInfo

public PClassInfo<?> getClassInfo()

Description copied from interface: Value

Returns information about the Pkl class associated with this Value.

Specified by:

getClassInfo in interface Value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object