Module org.glassfish.corba.rmic
Package org.glassfish.rmic.tools.java

Class ClassDefinition

java.lang.Object
org.glassfish.rmic.tools.java.ClassDefinition
All Implemented Interfaces:
Constants, RuntimeConstants
Direct Known Subclasses:
BinaryClass, SourceClass
public abstract class ClassDefinition extends Object implements Constants
This class is a Java class definition WARNING: The contents of this source file are not part of any supported API. Code that depends on them does so at its own risk: they are subject to change or removal without notice.

  • Field Details

    • source

      protected Object source

    • where

      protected long where

    • modifiers

      protected int modifiers

    • localName

      protected Identifier localName

    • declaration

      protected ClassDeclaration declaration

    • superClassId

      protected IdentifierToken superClassId

    • interfaceIds

      protected IdentifierToken[] interfaceIds

    • superClass

      protected ClassDeclaration superClass

    • interfaces

      protected ClassDeclaration[] interfaces

    • outerClass

      protected ClassDefinition outerClass

    • outerMember

      protected MemberDefinition outerMember

    • innerClassMember

      protected MemberDefinition innerClassMember

    • firstMember

      protected MemberDefinition firstMember

    • lastMember

      protected MemberDefinition lastMember

    • resolved

      protected boolean resolved

    • documentation

      protected String documentation

    • error

      protected boolean error

    • nestError

      protected boolean nestError

    • references

      protected UplevelReference references

    • referencesFrozen

      protected boolean referencesFrozen

    • classContext

      protected Context classContext

    • supersCheckStarted

      protected boolean supersCheckStarted

    • doInheritanceChecks

      protected static boolean doInheritanceChecks
      A flag used by turnOffInheritanceChecks() to indicate if inheritance checks are on or off.

  • Constructor Details

  • Method Details

    • getClassContext

      public Context getClassContext()

    • getSource

      public final Object getSource()
      Get the source of the class

    • getError

      public final boolean getError()
      Check if there were any errors in this class.

    • setError

      public final void setError()
      Mark this class to be erroneous.

    • getNestError

      protected final boolean getNestError()
      Check if there were any errors in our class nest.

    • getWhere

      public final long getWhere()
      Get the position in the input binary

    • getClassDeclaration

      public final ClassDeclaration getClassDeclaration()
      Get the class declaration

    • getModifiers

      public final int getModifiers()
      Get the class' modifiers

    • subModifiers

      public final void subModifiers(int mod)

    • addModifiers

      public final void addModifiers(int mod)

    • getSuperClass

      public final ClassDeclaration getSuperClass()
      Get the class' super class

    • getSuperClass

      public ClassDeclaration getSuperClass(Environment env)
      Get the super class, and resolve names now if necessary. It is only possible to resolve names at this point if we are a source class. The provision of this method at this level in the class hierarchy is dubious, but see 'getInnerClass' below. All other calls to 'getSuperClass(env)' appear in 'SourceClass'. NOTE: An older definition of this method has been moved to 'SourceClass', where it overrides this one.
      See Also:

    • getInterfaces

      public final ClassDeclaration[] getInterfaces()
      Get the class' interfaces

    • getOuterClass

      public final ClassDefinition getOuterClass()
      Get the class' enclosing class (or null if not inner)

    • setOuterClass

      protected final void setOuterClass(ClassDefinition outerClass)
      Set the class' enclosing class. Must be done at most once.

    • setOuterMember

      protected final void setOuterMember(MemberDefinition outerMember)
      Set the class' enclosing current instance pointer. Must be done at most once.

    • isInnerClass

      public final boolean isInnerClass()
      Tell if the class is inner. This predicate also returns true for top-level nested types. To test for a true inner class as seen by the programmer, use !isTopLevel().

    • isMember

      public final boolean isMember()
      Tell if the class is a member of another class. This is false for package members and for block-local classes.

    • isTopLevel

      public final boolean isTopLevel()
      Tell if the class is "top-level", which is either a package member, or a static member of another top-level class.

    • isInsideLocal

      public final boolean isInsideLocal()
      Tell if the class is local or inside a local class, which means it cannot be mentioned outside of its file.

    • getLocalName

      public Identifier getLocalName()
      Return a simple identifier for this class (idNull if anonymous).

    • setLocalName

      protected void setLocalName(Identifier name)
      Set the local name of a class. Must be a local class.

    • getInnerClassMember

      public final MemberDefinition getInnerClassMember()
      If inner, get the field for this class in the enclosing class

    • findOuterMember

      public final MemberDefinition findOuterMember()
      If inner, return an innermost uplevel self pointer, if any exists. Otherwise, return null.

    • isStatic

      public final boolean isStatic()
      See if this is a (nested) static class.

    • getTopClass

      public final ClassDefinition getTopClass()
      Get the class' top-level enclosing class

    • getFirstMember

      public final MemberDefinition getFirstMember()
      Get the class' first field or first match

    • getFirstMatch

      public final MemberDefinition getFirstMatch(Identifier name)

    • getName

      public final Identifier getName()
      Get the class' name

    • getType

      public final Type getType()
      Get the class' type

    • containsDeprecated

      public static boolean containsDeprecated(String documentation)
      Return true if the given documentation string contains a deprecation paragraph. This is true if the string contains the tag @deprecated is the first word in a line.

    • inSamePackage

      public final boolean inSamePackage(ClassDefinition c)

    • isInterface

      public final boolean isInterface()
      Checks

    • isClass

      public final boolean isClass()

    • isPublic

      public final boolean isPublic()

    • isPrivate

      public final boolean isPrivate()

    • isProtected

      public final boolean isProtected()

    • isPackagePrivate

      public final boolean isPackagePrivate()

    • isFinal

      public final boolean isFinal()

    • isAbstract

      public final boolean isAbstract()

    • isSynthetic

      public final boolean isSynthetic()

    • isDeprecated

      public final boolean isDeprecated()

    • isAnonymous

      public final boolean isAnonymous()

    • isLocal

      public final boolean isLocal()

    • hasConstructor

      public final boolean hasConstructor()

    • mustBeAbstract

      public final boolean mustBeAbstract(Environment env)
      Check to see if a class must be abstract. This method replaces isAbstract(env)

    • superClassOf

      public boolean superClassOf(Environment env, ClassDeclaration otherClass) throws ClassNotFound
      Check if this is a super class of another class
      Throws:
      ClassNotFound

    • enclosingClassOf

      public boolean enclosingClassOf(ClassDefinition otherClass)
      Check if this is an enclosing class of another class

    • subClassOf

      public boolean subClassOf(Environment env, ClassDeclaration otherClass) throws ClassNotFound
      Check if this is a sub class of another class
      Throws:
      ClassNotFound

    • implementedBy

      public boolean implementedBy(Environment env, ClassDeclaration c) throws ClassNotFound
      Check if this class is implemented by another class
      Throws:
      ClassNotFound

    • extendsCanAccess

      protected boolean extendsCanAccess(Environment env, ClassDeclaration c) throws ClassNotFound
      Check if another class can be accessed from the 'extends' or 'implements' clause of this class.
      Throws:
      ClassNotFound

    • canAccess

      public boolean canAccess(Environment env, ClassDeclaration c) throws ClassNotFound
      Check if another class can be accessed from within the body of this class.
      Throws:
      ClassNotFound

    • canAccess

      public boolean canAccess(Environment env, MemberDefinition f) throws ClassNotFound
      Check if a field can be accessed from a class
      Throws:
      ClassNotFound

    • permitInlinedAccess

      public boolean permitInlinedAccess(Environment env, ClassDeclaration c) throws ClassNotFound
      Check if a class is entitled to inline access to a class from another class.
      Throws:
      ClassNotFound

    • permitInlinedAccess

      public boolean permitInlinedAccess(Environment env, MemberDefinition f) throws ClassNotFound
      Check if a class is entitled to inline access to a method from another class.
      Throws:
      ClassNotFound

    • protectedAccess

      public boolean protectedAccess(Environment env, MemberDefinition f, Type accessorType) throws ClassNotFound
      We know the field is marked protected (and not public) and that the field is visible (as per canAccess). Can we access the field as ., where has the type ? Protected fields can only be accessed when the accessorType is a subclass of the current class
      Throws:
      ClassNotFound

    • getAccessMember

      public MemberDefinition getAccessMember(Environment env, Context ctx, MemberDefinition field, boolean isSuper)
      Find or create an access method for a private member, or return null if this is not possible.

    • getUpdateMember

      public MemberDefinition getUpdateMember(Environment env, Context ctx, MemberDefinition field, boolean isSuper)
      Find or create an update method for a private member, or return null if this is not possible.

    • getVariable

      public MemberDefinition getVariable(Environment env, Identifier nm, ClassDefinition source) throws AmbiguousMember, ClassNotFound
      Get a field from this class. Report ambiguous fields. If no accessible field is found, this method may return an inaccessible field to allow a useful error message. getVariable now takes the source class `source' as an argument. This allows getVariable to check whether a field is inaccessible before it signals that a field is ambiguous. The compiler used to signal an ambiguity even when one of the fields involved was not accessible. (bug 4053724)
      Throws:
      AmbiguousMember
      ClassNotFound

    • reportDeprecated

      public boolean reportDeprecated(Environment env)
      Tells whether to report a deprecation error for this class.

    • noteUsedBy

      public void noteUsedBy(ClassDefinition ref, long where, Environment env)
      Note that this class is being used somehow by ref. Report deprecation errors, etc.

    • getInnerClass

      public MemberDefinition getInnerClass(Environment env, Identifier nm) throws ClassNotFound
      Get an inner class. Look in supers but not outers. (This is used directly to resolve expressions like "site.K", and inside a loop to resolve lone names like "K" or the "K" in "K.L".) Called from 'Context' and 'FieldExpression' as well as this class.
      Throws:
      ClassNotFound

    • matchMethod

      public MemberDefinition matchMethod(Environment env, ClassDefinition accessor, Identifier methodName, Type[] argumentTypes) throws AmbiguousMember, ClassNotFound
      Lookup a method. This code implements the method lookup mechanism specified in JLS 15.11.2. This mechanism cannot be used to lookup synthetic methods.
      Throws:
      AmbiguousMember
      ClassNotFound

    • matchMethod

      public MemberDefinition matchMethod(Environment env, ClassDefinition accessor, Identifier methodName) throws AmbiguousMember, ClassNotFound
      Lookup a method. This code implements the method lookup mechanism specified in JLS 15.11.2. This mechanism cannot be used to lookup synthetic methods.
      Throws:
      AmbiguousMember
      ClassNotFound

    • matchAnonConstructor

      public MemberDefinition matchAnonConstructor(Environment env, Identifier accessPackage, Type[] argumentTypes) throws AmbiguousMember, ClassNotFound
      A version of matchMethod to be used only for constructors when we cannot pass in a sourceClass argument. We just assert our package name. This is used only for anonymous classes, where we have to look up a (potentially) protected constructor with no valid sourceClass parameter available.
      Throws:
      AmbiguousMember
      ClassNotFound

    • findMethod

      public MemberDefinition findMethod(Environment env, Identifier nm, Type t) throws ClassNotFound
      Find a method, ie: exact match in this class or any of the super classes. Only called by javadoc. For now I am holding off rewriting this code to rely on collectInheritedMethods(), as that code has not gotten along with javadoc in the past.
      Throws:
      ClassNotFound

    • basicCheck

      protected void basicCheck(Environment env) throws ClassNotFound
      Throws:
      ClassNotFound

    • check

      public void check(Environment env) throws ClassNotFound
      Check this class.
      Throws:
      ClassNotFound

    • checkLocalClass

      public Vset checkLocalClass(Environment env, Context ctx, Vset vset, ClassDefinition sup, Expression[] args, Type[] argTypes) throws ClassNotFound
      Throws:
      ClassNotFound

    • getPermanentlyAbstractMethods

      protected Iterator<MemberDefinition> getPermanentlyAbstractMethods()
      This method returns an Iterator of all abstract methods in our superclasses which we are unable to implement.

    • turnOffInheritanceChecks

      public static void turnOffInheritanceChecks()
      This is a workaround to allow javadoc to turn off certain inheritance/override checks which interfere with javadoc badly. In the future it might be good to eliminate the shared sources of javadoc and javac to avoid the need for this sort of workaround.

    • collectInheritedMethods

      protected void collectInheritedMethods(Environment env)

      Collect all methods defined in this class or inherited from any of our superclasses or interfaces. Look for any incompatible definitions.

      This function is also responsible for collecting the Miranda methods for a class. For a definition of Miranda methods, see the comment in addMirandaMethods() below.

    • getMethods

      protected Iterator<MemberDefinition> getMethods(Environment env)
      Get an Iterator of all methods which could be accessed in an instance of this class.

    • getMethods

      public Iterator<MemberDefinition> getMethods()
      Get an Iterator of all methods which could be accessed in an instance of this class. Throw a compiler error if we haven't generated this information yet.

    • addMirandaMethods

      protected void addMirandaMethods(Environment env, Iterator<MemberDefinition> mirandas)
      Add a list of methods to this class as miranda methods. This gets overridden with a meaningful implementation in SourceClass. BinaryClass should not need to do anything -- it should already have its miranda methods and, if it doesn't, then that doesn't affect our compilation.

    • inlineLocalClass

      public void inlineLocalClass(Environment env)

    • resolveTypeStructure

      public void resolveTypeStructure(Environment env)
      We create a stub for this. Source classes do more work. Some calls from 'SourceClass.checkSupers' execute this method.
      See Also:

    • resolveName

      public Identifier resolveName(Environment env, Identifier name)
      Look up an inner class name, from somewhere inside this class. Since supers and outers are in scope, search them too.

      If no inner class is found, env.resolveName() is then called, to interpret the ambient package and import directives.

      This routine operates on a "best-efforts" basis. If at some point a class is not found, the partially-resolved identifier is returned. Eventually, someone else has to try to get the ClassDefinition and diagnose the ClassNotFound.

      resolveName() looks at surrounding scopes, and hence pulling in both inherited and uplevel types. By contrast, resolveInnerClass() is intended only for interpreting explicitly qualified names, and so look only at inherited types. Also, resolveName() looks for package prefixes, which appear similar to "very uplevel" outer classes.

      A similar (but more complex) name-lookup process happens when field and identifier expressions denoting qualified names are type-checked. The added complexity comes from the fact that variables may occur in such names, and take precedence over class and package names.

      In the expression type-checker, resolveInnerClass() is paralleled by code in FieldExpression.checkAmbigName(), which also calls ClassDefinition.getInnerClass() to interpret names of the form "OuterClass.Inner" (and also outerObject.Inner). The checking of an identifier expression that fails to be a variable is referred directly to resolveName().

    • resolveInnerClass

      public Identifier resolveInnerClass(Environment env, Identifier nm)
      Interpret a qualified class name, which may have further subcomponents.. Follow inheritance links, as in: class C { class N { } } class D extends C { } ... new D.N() ... Ignore outer scopes and packages.

    • findAnyMethod

      public MemberDefinition findAnyMethod(Environment env, Identifier nm) throws ClassNotFound
      Find any method with a given name.
      Throws:
      ClassNotFound

    • diagnoseMismatch

      public int diagnoseMismatch(Environment env, Identifier nm, Type[] argTypes, int start, Type[] margTypeResult) throws ClassNotFound
      Given the fact that this class has no method "nm" matching "argTypes", find out if the mismatch can be blamed on a particular actual argument which disagrees with all of the overloadings. If so, return the code (i<<2)+(castOK<<1)+ambig, where "i" is the number of the offending argument, and "castOK" is 1 if a cast could fix the problem. The target type for the argument is returned in margTypeResult[0]. If not all methods agree on this type, "ambig" is 1. If there is more than one method, the choice of target type is arbitrary.

      Return -1 if every argument is acceptable to at least one method. Return -2 if there are no methods of the required arity. The value "start" gives the index of the first argument to begin checking.

      Throws:
      ClassNotFound

    • addMember

      protected void addMember(MemberDefinition field)
      Add a field (no checks)

    • addMember

      public void addMember(Environment env, MemberDefinition field)
      Add a field (subclasses make checks)

    • getReference

      public UplevelReference getReference(LocalMember target)
      Find or create an uplevel reference for the given target.

    • getReferences

      public UplevelReference getReferences()
      Return the list of all uplevel references.

    • getReferencesFrozen

      public UplevelReference getReferencesFrozen()
      Return the same value as getReferences. Also, mark the set of references frozen. After that, it is an error to add new references.

    • referencesMustNotBeFrozen

      public final void referencesMustNotBeFrozen()
      assertion check

    • getClassLiteralLookup

      public MemberDefinition getClassLiteralLookup(long fwhere)
      Get helper method for class literal lookup.

    • loadNested

      public void loadNested(Environment env)

    • getDependencies

      public Iterator<ClassDeclaration> getDependencies()

    • addDependency

      public void addDependency(ClassDeclaration c)
      Add a dependency

    • getLocalClass

      public ClassDefinition getLocalClass(String name)
      Maintain a hash table of local and anonymous classes whose internal names are prefixed by the current class. The key is the simple internal name, less the prefix.

    • addLocalClass

      public void addLocalClass(ClassDefinition c, String name)

    • print

      public void print(PrintStream out)
      Print for debugging

    • toString

      public String toString()
      Convert to String
      Overrides:
      toString in class Object

    • cleanup

      public void cleanup(Environment env)
      After the class has been written to disk, try to free up some storage.