Package org.pkl.core.runtime
Class VmObject
- java.lang.Object
-
- org.pkl.core.runtime.VmValue
-
- org.pkl.core.runtime.VmObjectLike
-
- org.pkl.core.runtime.VmObject
-
public abstract class VmObject extends VmObjectLike
Corresponds to `pkl.base#Object`.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.pkl.core.runtime.VmObjectLike
VmObjectLike.ForcedMemberValueConsumer, VmObjectLike.MemberValueConsumer
-
-
Field Summary
Fields Modifier and Type Field Description protected intcachedHashprotected org.graalvm.collections.EconomicMap<java.lang.Object,java.lang.Object>cachedValuesprotected org.graalvm.collections.UnmodifiableEconomicMap<java.lang.Object,ObjectMember>membersprotected @Nullable VmObjectparent-
Fields inherited from class org.pkl.core.runtime.VmObjectLike
enclosingFrame, extraStorage
-
-
Constructor Summary
Constructors Constructor Description VmObject(com.oracle.truffle.api.frame.MaterializedFrame enclosingFrame, @Nullable VmObject parent, org.graalvm.collections.UnmodifiableEconomicMap<java.lang.Object,ObjectMember> members)VmObject(com.oracle.truffle.api.frame.MaterializedFrame enclosingFrame, @Nullable VmObject parent, org.graalvm.collections.UnmodifiableEconomicMap<java.lang.Object,ObjectMember> members, org.graalvm.collections.EconomicMap<java.lang.Object,java.lang.Object> cachedValues)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.Map<java.lang.String,java.lang.Object>exportMembers()Exports this object's members.voidforce(boolean allowUndefinedValues)Forces recursive (deep) evaluation of this value.voidforce(boolean allowUndefinedValues, boolean recurse)Evaluates this object's members.booleanforceAndIterateMemberValues(VmObjectLike.ForcedMemberValueConsumer consumer)Same asVmObjectLike.iterateMemberValues(org.pkl.core.runtime.VmObjectLike.MemberValueConsumer)except that it first performs a shallowVmObjectLike.force(boolean, boolean).@Nullable java.lang.ObjectgetCachedValue(java.lang.Object key)Reads from the properties cache for this object.@Nullable ObjectMembergetMember(java.lang.Object key)Always prefer this method over `getMembers().get(key)`.org.graalvm.collections.UnmodifiableEconomicMap<java.lang.Object,ObjectMember>getMembers()Returns the declared members of this object.@Nullable VmObjectgetParent()Returns the parent object in the prototype chain.booleanhasCachedValue(java.lang.Object key)Prefer this method overVmObjectLike.getCachedValue(java.lang.Object)if the value is not required.booleanhasMember(java.lang.Object key)Always prefer this method over `getMembers().containsKey(key)`.booleaniterateAlreadyForcedMemberValues(VmObjectLike.ForcedMemberValueConsumer consumer)booleaniterateMembers(java.util.function.BiFunction<java.lang.Object,ObjectMember,java.lang.Boolean> consumer)Iterates over member definitions in order of their definition, from the top of the prototype chain downwards.booleaniterateMemberValues(VmObjectLike.MemberValueConsumer consumer)Iterates over member definitions and their values in order of their definition, from the top of the prototype chain downwards.voidlateInitParent(VmObject parent)voidsetCachedValue(java.lang.Object key, java.lang.Object value)Writes to the properties cache for this object.java.lang.StringtoString()-
Methods inherited from class org.pkl.core.runtime.VmObjectLike
export, getEnclosingFrame, getEnclosingOwner, getEnclosingReceiver, getExtraStorage, hasExtraStorage, isModuleObject, setExtraStorage
-
Methods inherited from class org.pkl.core.runtime.VmValue
accept, accept, equals, export, exportNullable, force, getPrototype, getVmClass, isDynamic, isListing, isMapping, isPrototype, isSequence, isTyped
-
-
-
-
Field Detail
-
members
protected final org.graalvm.collections.UnmodifiableEconomicMap<java.lang.Object,ObjectMember> members
-
cachedValues
protected final org.graalvm.collections.EconomicMap<java.lang.Object,java.lang.Object> cachedValues
-
cachedHash
protected int cachedHash
-
-
Constructor Detail
-
VmObject
public VmObject(com.oracle.truffle.api.frame.MaterializedFrame enclosingFrame, @Nullable VmObject parent, org.graalvm.collections.UnmodifiableEconomicMap<java.lang.Object,ObjectMember> members, org.graalvm.collections.EconomicMap<java.lang.Object,java.lang.Object> cachedValues)
-
VmObject
public VmObject(com.oracle.truffle.api.frame.MaterializedFrame enclosingFrame, @Nullable VmObject parent, org.graalvm.collections.UnmodifiableEconomicMap<java.lang.Object,ObjectMember> members)
-
-
Method Detail
-
lateInitParent
public final void lateInitParent(VmObject parent)
-
getParent
public @Nullable VmObject getParent()
Description copied from class:VmObjectLikeReturns the parent object in the prototype chain. For each concrete subclass X of VmOwner, the exact return type of this method is `X|VmTyped`.- Specified by:
getParentin classVmObjectLike
-
hasMember
public final boolean hasMember(java.lang.Object key)
Description copied from class:VmObjectLikeAlways prefer this method over `getMembers().containsKey(key)`.- Specified by:
hasMemberin classVmObjectLike
-
getMember
public final @Nullable ObjectMember getMember(java.lang.Object key)
Description copied from class:VmObjectLikeAlways prefer this method over `getMembers().get(key)`.- Specified by:
getMemberin classVmObjectLike
-
getMembers
public final org.graalvm.collections.UnmodifiableEconomicMap<java.lang.Object,ObjectMember> getMembers()
Description copied from class:VmObjectLikeReturns the declared members of this object.- Specified by:
getMembersin classVmObjectLike
-
getCachedValue
public final @Nullable java.lang.Object getCachedValue(java.lang.Object key)
Description copied from class:VmObjectLikeReads from the properties cache for this object. The cache contains the values of all members defined in this object or an ancestor thereof which have been requested with this object as the receiver.- Specified by:
getCachedValuein classVmObjectLike
-
setCachedValue
public final void setCachedValue(java.lang.Object key, java.lang.Object value)Description copied from class:VmObjectLikeWrites to the properties cache for this object. The cache contains the values of all members defined in this object or an ancestor thereof which have been requested with this object as the receiver.- Specified by:
setCachedValuein classVmObjectLike
-
hasCachedValue
public final boolean hasCachedValue(java.lang.Object key)
Description copied from class:VmObjectLikePrefer this method overVmObjectLike.getCachedValue(java.lang.Object)if the value is not required. (There is no point in calling this method to determine whether to callVmObjectLike.getCachedValue(java.lang.Object).)- Specified by:
hasCachedValuein classVmObjectLike
-
iterateMemberValues
public final boolean iterateMemberValues(VmObjectLike.MemberValueConsumer consumer)
Description copied from class:VmObjectLikeIterates over member definitions and their values in order of their definition, from the top of the prototype chain downwards. If a member value has not yet been evaluated, a `null` `value` is passed to `consumer`. If a member is defined in multiple objects in the prototype chain, i.e., is overridden along the way, it is visited only once, with the initial (i.e., upmost) `member` and the final (i.e., downmost) `value`. (This peculiar behavior serves two purposes in the current implementation: it guarantees that a `hidden` property is still recognized as such when overridden, and that an element is still recognized as such when overridden with entry syntax. It also means that members are visited in order of (first) definition.) Local, hidden, and external properties are not visited. If an invocation of `consumer` returns `false`, the remaining members are not visited, and `false` is returned. Otherwise, all members are visited, and `true` is returned.- Specified by:
iterateMemberValuesin classVmObjectLike
-
forceAndIterateMemberValues
public final boolean forceAndIterateMemberValues(VmObjectLike.ForcedMemberValueConsumer consumer)
Description copied from class:VmObjectLikeSame asVmObjectLike.iterateMemberValues(org.pkl.core.runtime.VmObjectLike.MemberValueConsumer)except that it first performs a shallowVmObjectLike.force(boolean, boolean). As a consequence, values passed toconsumerare guaranteed to be non-null.- Specified by:
forceAndIterateMemberValuesin classVmObjectLike
-
iterateAlreadyForcedMemberValues
public final boolean iterateAlreadyForcedMemberValues(VmObjectLike.ForcedMemberValueConsumer consumer)
- Specified by:
iterateAlreadyForcedMemberValuesin classVmObjectLike
-
iterateMembers
public final boolean iterateMembers(java.util.function.BiFunction<java.lang.Object,ObjectMember,java.lang.Boolean> consumer)
Description copied from class:VmObjectLikeIterates over member definitions in order of their definition, from the top of the prototype chain downwards. If a member is defined multiple times, each occurrence is visited. Local properties are not visited. If an invocation of `consumer` returns `false`, the remaining members are not visited, and `false` is returned. Otherwise, all members are visited, and `true` is returned.- Specified by:
iterateMembersin classVmObjectLike
-
force
public final void force(boolean allowUndefinedValues, boolean recurse)Evaluates this object's members. Skips local, hidden, and external members.- Specified by:
forcein classVmObjectLike
-
force
public final void force(boolean allowUndefinedValues)
Description copied from class:VmValueForces recursive (deep) evaluation of this value.
-
toString
public final java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
exportMembers
protected final java.util.Map<java.lang.String,java.lang.Object> exportMembers()
Exports this object's members. Skips local members, hidden members, class definitions, and type aliases. Members that haven't been forced have a `null` value.
-
-