JInterfaceDeclarationWrapper (JML and MultiJava documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

JML

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jmlspecs.checker
Class JInterfaceDeclarationWrapper

java.lang.Object
  org.multijava.util.Utils
      org.multijava.util.compiler.Phylum
          org.multijava.mjc.JPhylum
              org.multijava.mjc.JMemberDeclaration
                  org.multijava.mjc.JTypeDeclaration
                      org.multijava.mjc.JInterfaceDeclaration
                          org.jmlspecs.checker.JInterfaceDeclarationWrapper

All Implemented Interfaces:: Annotatable, Cloneable, Comparable, CompilerPassEnterable, Constants, Constants, Constants, JInterfaceDeclarationType, JMemberDeclarationType, JTypeDeclarationType, PhylumType

public class JInterfaceDeclarationWrapper
extends JInterfaceDeclaration
implements Constants

This class represents a java interface in the syntax tree

Field Detail

isRefinedType

protected boolean isRefinedType

Constructor Detail

JInterfaceDeclarationWrapper

public JInterfaceDeclarationWrapper(TokenReference where,
                                    long modifiers,
                                    String ident,
                                    CTypeVariable[] typevariables,
                                    CClassType[] interfaces,
                                    ArrayList methods,
                                    ArrayList inners,
                                    JPhylum[] fieldsAndInits,
                                    JavadocComment javadoc,
                                    JavaStyleComment[] comments,
                                    boolean isRefinedType)

Constructs an interface declaration in the parsing tree.

Parameters:: where - the line of this node in the source code; modifiers - the list of modifiers of this class; ident - the short name of this class; interfaces - the names of this types's interfaces; methods - a list of JMethodDeclarationTypes giving the methods of this type; inners - a list of JTypeDeclarationTypes giving the inner classes (and interfaces) of this type; fieldsAndInits - the fields and initializers of this type, passed together because the order matters for class and object initialization, members of the array should be instances of JFieldDeclarationType or JClassBlock; javadoc - javadoc comments including whether this type declaration is deprecated; comments - regular java comments
See Also:: JMethodDeclarationType, JFieldDeclarationType, JClassBlock

Method Detail

makeSignature

protected CSourceClass makeSignature(Main compiler,
                                     CClass owner,
                                     CMemberHost host,
                                     String prefix,
                                     boolean isAnon,
                                     boolean isMember)

Generates the signature object for this. This method is overridden here to return an instance of JmlSourceClass.

Overrides:: makeSignature in class JTypeDeclaration

Parameters:: compiler - the compiler instance for which this signature is generated; owner - the class signature singleton for the logical outer class of this, or null if this is a top level declaration; host - the signature singleton of the context in which this is declared, a CCompilationUnit for top-level declarations; prefix - the prefix prepended to this declaration's identifier to achieve the fully qualified name, just the package name (using '/' separators) for top-level classes, package name plus $-delimited outer class names plus synthetic index for inner classes; isAnon - true if this is an anonymous class, in which case the fully qualified name is just prefix; isMember - true if this is a member type, i.e., a nested type that is not a local type or an anonymous class

checkInterface

public void checkInterface(CContextType context)
                    throws PositionedError

Checks the basic interfaces to make sure things generally look OK. This pass gathers information about the type signatures of everything (imported class files, classes being compiled, methods, fields, etc...) needed for the later passes. This information is stored in a CCompilationUnit instance and instances of CMember that are bound to the AST. Also adds things like the default constructor and the initializer method to the AST (these are suppressed during pretty-printing). This method is overridden herre to take account of instance model fields.

Specified by:: checkInterface in interface JTypeDeclarationType
Overrides:: checkInterface in class JInterfaceDeclaration

Parameters:: context - the context in which this declaration appears
Throws:: PositionedError - an error with reference to the source file

checkInitializers

public void checkInitializers(CContextType context)
                       throws PositionedError

Checks the static initializers created during the checkInterface pass and performs some other checks that can be performed simply before full blown typechecking. This method is overridden herre to take account of instance model fields.

Specified by:: checkInitializers in interface JTypeDeclarationType
Overrides:: checkInitializers in class JInterfaceDeclaration

Parameters:: context - the context in which this class declaration appears
Throws:: PositionedError - if check fails

constructStaticInitializers

protected JInitializerDeclaration constructStaticInitializers()

Builds and returns static initializers. If there is no static, this method returns null. This method is refined here to take into account of model fields.

Overrides:: constructStaticInitializers in class JInterfaceDeclaration

constructInitializers

protected JInitializerDeclaration constructInitializers(boolean isStatic)

Collects all initializers and builds a single method.

Parameters:: isStatic - build class (static) or instance initializers?

compareTo

public int compareTo(Object o)
              throws ClassCastException

Description copied from class: JTypeDeclaration

Compares this to a given object.


also
ensures (* \result == lexically ordered according to the type name *);
also
requires o != null && !(o instanceof JTypeDeclaration);
signals_only ClassCastException;

Specified by:: compareTo in interface Comparable
Overrides:: compareTo in class JTypeDeclaration

Throws:: ClassCastException

isRefinedType

public boolean isRefinedType()

hasModifier

private boolean hasModifier(JFieldDeclarationType field,
                            int mod)

Returns true if the given filed declaration has the given modifier.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

JML

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

JML is Copyright (C) 1998-2002 by Iowa State University and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This release depends on code from the MultiJava project and is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.

Constructor Summary
`JInterfaceDeclarationWrapper(TokenReference where, long modifiers, String ident, CTypeVariable[] typevariables, CClassType[] interfaces, ArrayList methods, ArrayList inners, JPhylum[] fieldsAndInits, JavadocComment javadoc, JavaStyleComment[] comments, boolean isRefinedType)` Constructs an interface declaration in the parsing tree.

Method Summary
`void`	`checkInitializers(CContextType context)` Checks the static initializers created during the checkInterface pass and performs some other checks that can be performed simply before full blown typechecking.
`void`	`checkInterface(CContextType context)` Checks the basic interfaces to make sure things generally look OK.
`int`	`compareTo(Object o)` Compares this to a given object.
`protected JInitializerDeclaration`	`constructInitializers(boolean isStatic)` Collects all initializers and builds a single method.
`protected JInitializerDeclaration`	`constructStaticInitializers()` Builds and returns `static` initializers.
`private boolean`	`hasModifier(JFieldDeclarationType field, int mod)` Returns `true` if the given filed declaration has the given modifier.
`boolean`	`isRefinedType()`
`protected CSourceClass`	`makeSignature(Main compiler, CClass owner, CMemberHost host, String prefix, boolean isAnon, boolean isMember)` Generates the signature object for this.

org.jmlspecs.checker Class JInterfaceDeclarationWrapper

isRefinedType

JInterfaceDeclarationWrapper

makeSignature

checkInterface

checkInitializers

constructStaticInitializers

constructInitializers

compareTo

isRefinedType

hasModifier

org.jmlspecs.checker
Class JInterfaceDeclarationWrapper