ClassFile

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. val accessFlags: Int

   

   The access flags of this class.

   The access flags of this class. To further analyze the access flags either use the corresponding convenience methods (e.g., isEnumDeclaration()) or the class org.opalj.bi.AccessFlagsIterator or the classes which inherit from org.opalj.bi.AccessFlag.

   Definition Classes

   ClassFile → ConcreteSourceElement

5. def annotations: Annotations

   

   The list of all annotations.

   The list of all annotations. In general, if a specific annotation is searched for the method runtimeVisibleAnnotations or runtimeInvisibleAnnotations should be used.

   Definition Classes

   CommonSourceElementAttributes

6. final def asClassFile: ClassFile.this.type

   

   Definition Classes

   ClassFile → SourceElement

7. def asField: Field

   

   Definition Classes

   SourceElement

8. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

9. def asMethod: Method

   

   Definition Classes

   SourceElement

10. def asVirtualClass: VirtualClass

    

11. val attributes: Attributes

    

    This class file's reified attributes.

    This class file's reified attributes. Which attributes are reified depends on the configuration of the class file reader; e.g., org.opalj.br.reader.Java8Framework. The JVM specification defines the following attributes:

    • InnerClasses
    • EnclosingMethod
    • Synthetic
    • Signature
    • SourceFile
    • SourceDebugExtension
    • Deprecated
    • RuntimeVisibleAnnotations
    • RuntimeInvisibleAnnotations In case of Java 9 (org.opalj.br.reader.Java9Framework) the following attributes are added:
    • Module_attribute
    • TODO ConcealedPackages_attribute
    • TODO Version_attribute
    • TODO MainClass_attribute
    • TODO TargetPlatform_attribute The BootstrapMethods attribute, which is also defined by the JVM specification, may, however, be resolved and is then no longer part of the attributes table of the class file. The BootstrapMethods attribute is basically the container for the bootstrap methods referred to by the org.opalj.br.instructions.INVOKEDYNAMIC instructions.

    Definition Classes

    ClassFile → CommonAttributes

12. def bootstrapMethodTable: Option[BootstrapMethodTable]

    

    Returns this class file's bootstrap method table.

    Returns this class file's bootstrap method table.

    Note

    A class file's bootstrap method table may be removed at load time if the corresponding org.opalj.br.instructions.INVOKEDYNAMIC instructions are rewritten.

13. def classSignature: Option[ClassSignature]

    

    Each class file optionally defines a class signature.

14. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

15. def constructors: Iterator[Method]

    

    All constructors/instance initialization methods (<init>) defined by this class.

    All constructors/instance initialization methods (<init>) defined by this class.

    (This does not include static initializers.)

16. def copy(version: UShortPair = this.version, accessFlags: Int = this.accessFlags, thisType: ObjectType = this.thisType, superclassType: Option[ObjectType] = this.superclassType, interfaceTypes: Seq[ObjectType] = this.interfaceTypes, fields: Fields = this.fields, methods: Methods = this.methods, attributes: Attributes = this.attributes): ClassFile

    

    Creates a shallow copy of this class file object.

    Creates a shallow copy of this class file object.

    fields

    The new set of fields; it need to be ordered by means of the ordering defined by Field.

    methods

    The new set of methods; it need to be ordered by means of the ordering defined by Method.

17. def enclosingMethod: Option[EnclosingMethod]

    

18. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

19. def equals(other: Any): Boolean

    

    Definition Classes

    ClassFile → AnyRef → Any

20. val fields: Fields

    

    The declared fields.

    The declared fields. May be empty. The list is sorted by name.

21. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

22. final def findDirectlyOverridingMethod(packageName: String, method: Method)(implicit logContext: LogContext): Option[Method]

    

23. def findDirectlyOverridingMethod(packageName: String, visibility: Option[VisibilityModifier], name: String, descriptor: MethodDescriptor)(implicit logContext: LogContext): Option[Method]

    

    Returns the method which directly overrides a method with the given properties.

    Returns the method which directly overrides a method with the given properties.

    Note

    This method is only defined for proper virtual methods.

24. final def findDissimilarity(other: ClassFile): Option[AnyRef]

    

    Compares this class file with the given one to find (the first) differences which may lead to a different load or runtime behavior.

    Compares this class file with the given one to find (the first) differences which may lead to a different load or runtime behavior. I.e., differences between this class and the given class which are irrelevant at load / runtime, such as the order in which the attributes are defined, are ignored.

    returns

    None if this class file and the other are equal - i.e., if both effectively implement the same class.

25. def findField(name: String, fieldType: FieldType): Option[Field]

    

    Returns the field with the given name and type.

26. def findField(name: String): Chain[Field]

    

    Returns the field with the given name, if any.

    Returns the field with the given name, if any.

    Note

    The complexity is O(log2 n); this algorithm uses binary search.

27. def findMethod(name: String, descriptor: MethodDescriptor, matcher: AccessFlagsMatcher): Option[Method]

    

28. def findMethod(name: String, descriptor: MethodDescriptor): Option[Method]

    

    Returns the method with the given name and descriptor that is declared by this class file.

    Returns the method with the given name and descriptor that is declared by this class file.

    Note

    The complexity is O(log2 n); this algorithm uses a binary search algorithm.

29. def findMethod(name: String): Chain[Method]

    

    Returns the methods (including constructors and static initializers) with the given name, if any.

    Returns the methods (including constructors and static initializers) with the given name, if any.

    Note

    The complexity is O(log2 n); this algorithm uses binary search.

30. def foreachNestedClass(f: (ClassFile) ⇒ Unit)(implicit classFileRepository: ClassFileRepository): Unit

    

    Iterates over all direct and indirect nested classes of this class file.

    Iterates over all direct and indirect nested classes of this class file.

    Example:

    1. To collect all nested types:

       var allNestedTypes: Set[ObjectType] = Set.empty
       foreachNestedClasses(innerclassesProject, { nc ⇒ allNestedTypes += nc.thisType })

31. final def foreachTypeAnnotation[U](f: (TypeAnnotation) ⇒ U): Unit

    

    Definition Classes

    CommonAttributes

32. def fqn: String

    

    The fully qualified name of the type defined by this class file.

33. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

34. def hasDefaultConstructor: Boolean

    

    Returns true if this class defines a so-called default constructor.

    Returns true if this class defines a so-called default constructor. A default constructor needs to be present, e.g., when the class is serializable.

    The default constructor is the constructor that takes no parameters.

    Note

    The result is recomputed.

35. def hashCode(): Int

    

    This class file's hasCode.

    This class file's hasCode. The hashCode is (by purpose) identical to the id of the ObjectType it implements.

    Definition Classes

    ClassFile → AnyRef → Any

36. def id: Int

    

    The unique id associated with the type defined by this class file.

37. def innerClasses: Option[InnerClasses]

    

    Returns the inner classes attribute, if defined.

    Returns the inner classes attribute, if defined.

    Note

    The inner classes attribute contains (for inner classes) also a reference to its outer class. Furthermore, it contains references to other inner classes that are not an inner class of this class. If you are just interested in the inner classes of this class, use the method nested classes.

    See also

    nestedClasses

38. def instanceMethods: Iterable[Method]

    

    All defined instance methods.

    All defined instance methods. I.e., all methods that are not static, constructors, or static initializers.

39. val interfaceTypes: Seq[ObjectType]

    

    The set of implemented interfaces.

    The set of implemented interfaces. May be empty.

40. def isAbstract: Boolean

    

41. def isAnnotationDeclaration: Boolean

    

42. def isAnonymousInnerClass: Boolean

    

    Returns true if this class file defines an anonymous inner class.

    Returns true if this class file defines an anonymous inner class.

    This method relies on the inner classes attribute to identify anonymous inner classes.

43. final def isClass: Boolean

    

    Definition Classes

    ClassFile → SourceElement

44. def isClassDeclaration: Boolean

    

45. def isDeprecated: Boolean

    

    Returns true if this (field, method, class) declaration is declared as deprecated.

    Returns true if this (field, method, class) declaration is declared as deprecated.

    Note

    The deprecated attribute is always set by the Java compiler when either the deprecated annotation or the JavaDoc tag is used.

    Definition Classes

    CommonSourceElementAttributes

46. def isEffectivelyFinal: Boolean

    

    Returns true if the class is final or if it only defines private constructors and it is therefore not possible to inherit from this class.

    Returns true if the class is final or if it only defines private constructors and it is therefore not possible to inherit from this class.

    An abstract type (abstract classes and interfaces) is never effectively final.

47. def isEnumDeclaration: Boolean

    

48. def isField: Boolean

    

    Definition Classes

    SourceElement

49. def isFinal: Boolean

    

50. def isInnerClass: Boolean

    

51. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

52. def isInterfaceDeclaration: Boolean

    

    Returns true if this class file represents an interface.

    Returns true if this class file represents an interface.

    Note

    From the JVM point-of-view annotations are also interfaces!

    See also

    org.opalj.br.analyses.Project to determine if this interface declaration is a functional interface.

53. def isMethod: Boolean

    

    Definition Classes

    SourceElement

54. def isModuleDeclaration: Boolean

    

55. def isPackageVisible: Boolean

    

    true if the class file has package visibility.

    true if the class file has package visibility. If false the method isPublic will return true.

    Note

    A class file cannot have private or protected visibility.

56. def isPublic: Boolean

    

    true if the class file has public visibility.

    true if the class file has public visibility. If false the method isPackageVisible will return true.

    Note

    There is no private or protected visibility.

57. def isSynthetic: Boolean

    

    True if this element was created by the compiler and the attribute Synthetic is present.

    True if this element was created by the compiler and the attribute Synthetic is present. Compilers are, however, free to use the attribute or the corresponding access flag.

    Definition Classes

    CommonSourceElementAttributes

58. def isVirtual: Boolean

    

    Definition Classes

    SourceElement

59. def isVirtualType: Boolean

    

    Returns true if this class file has no direct representation in the source code.

    Returns true if this class file has no direct representation in the source code.

    See also

    VirtualTypeFlag for further information.

60. final def jdkVersion: String

    

61. final def majorVersion: UShort

    

62. val methods: Methods

    

    The declared methods.

    The declared methods. May be empty. The list is first sorted by name, and then by method descriptor.

63. final def minorVersion: UShort

    

64. def module: Option[Module]

    

    Returns Java 9's module attribute if defined.

65. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

66. def nestedClasses(implicit classFileRepository: ClassFileRepository): Seq[ObjectType]

    

    Returns the set of all immediate nested classes of this class.

    Returns the set of all immediate nested classes of this class. I.e., returns those nested classes that are not defined in the scope of a nested class of this class.

67. final def notify(): Unit

    

    Definition Classes

    AnyRef

68. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

69. def outerType: Option[(ObjectType, Int)]

    

    Each class has at most one explicit, direct outer type.

    Each class has at most one explicit, direct outer type. Note that a local class (a class defined in the scope of a method) or an anonymous class do not specify an outer type.

    returns

    The object type of the outer type as well as the access flags of this inner class.

70. def runtimeInvisibleAnnotations: Annotations

    

    Definition Classes

    CommonSourceElementAttributes

71. def runtimeInvisibleTypeAnnotations: TypeAnnotations

    

    Definition Classes

    CommonAttributes

72. def runtimeVisibleAnnotations: Annotations

    

    Definition Classes

    CommonSourceElementAttributes

73. def runtimeVisibleTypeAnnotations: TypeAnnotations

    

    Definition Classes

    CommonAttributes

74. def similar(other: ClassFile): Boolean

    

    Compares this class file with the given one to check for differences which may lead to a different load or runtime behavior.

    Compares this class file with the given one to check for differences which may lead to a different load or runtime behavior. I.e., differences between this class and the given class which are irrelevant at load-/runtime, such as the order in which the attributes are defined, are ignored.

75. def sourceDebugExtension: Option[Array[Byte]]

    

    The SourceDebugExtension attribute is an optional attribute [...].

    The SourceDebugExtension attribute is an optional attribute [...]. There can be at most one SourceDebugExtension attribute. The data (which is modified UTF8 String may, however, not be representable using a String object (see the spec. for further details.)

    The returned Array must not be mutated.

76. def sourceFile: Option[String]

    

    The SourceFile attribute is an optional attribute [...].

    The SourceFile attribute is an optional attribute [...]. There can be at most one SourceFile attribute.

77. def staticInitializer: Option[Method]

    

    The static initializer of this class.

    The static initializer of this class.

    Note

    The way how the static initializer is identified has changed with Java 7. In a class file whose version number is 51.0 or above, the method must have its ACC_STATIC flag set. Other methods named <clinit> in a class file are of no consequence.

78. val superclassType: Option[ObjectType]

    

    The class type from which this class inherits.

    The class type from which this class inherits. None if this class file defines java.lang.Object or a module.

79. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

80. def synthesizedClassFiles: Option[SynthesizedClassFiles]

    

    Returns OPAL's SynthesizedClassFiles attribute if it is defined.

81. val thisType: ObjectType

    

    The type implemented by this class file.

82. def toString(): String

    

    Definition Classes

    ClassFile → AnyRef → Any

83. val version: UShortPair

    

    A pair of unsigned short values identifying the class file version number.

    A pair of unsigned short values identifying the class file version number. UShortPair(minorVersion, majorVersion).

84. def visibilityModifier: Option[VisibilityModifier]

    

    Definition Classes

    ConcreteSourceElement

85. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

86. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

87. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )