The OPAL Framework5.0.0 < Back

Packages

package root
Definition Classes
root
package org
Definition Classes
root
package opalj
OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode.
OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode. OPAL is designed with performance, scalability and adaptability in mind.
Its main components are:
- a library (Common) which provides generally useful data-structures and algorithms for static analyses.
- a framework for implementing lattice based static analyses (Static Analysis Infrastructure)
- a framework for parsing Java bytecode (Bytecode Infrastructure) that can be used to create arbitrary representations.
- a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler).
- a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
- a scalable, easily customizable framework for the abstract interpretation of Java bytecode (Abstract Interpretation Framework - org.opalj.ai).
- a library to extract dependencies between code elements and to facilitate checking architecture definitions.
- a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler).
General Design Decisions
Thread Safety
Unless explicitly noted, OPAL is thread safe. I.e., the classes defined by OPAL can be considered to be thread safe unless otherwise stated. (For example, it is possible to read and process class files concurrently without explicit synchronization on the client side.)
No null Values
Unless explicitly noted, OPAL does not null values I.e., fields that are accessible will never contain null values and methods will never return null. If a method accepts null as a value for a parameter or returns a null value it is always explicitly documented. In general, the behavior of methods that are passed null values is undefined unless explicitly documented.
No Typecasts for Collections
For efficiency reasons, OPAL sometimes uses mutable data-structures internally. After construction time, these data-structures are generally represented using their generic interfaces (e.g., scala.collection.{Set,Map}). However, a downcast (e.g., to add/remove elements) is always forbidden as it would effectively prevent thread-safety.
Assertions
OPAL makes heavy use of Scala's Assertion Facility to facilitate writing correct code. Hence, for production builds (after thorough testing(!)) it is highly recommend to build OPAL again using -Xdisable-assertions.
Definition Classes
org
package br
In this representation of Java bytecode references to a Java class file's constant pool and to attributes are replaced by direct references to the corresponding constant pool entries.
In this representation of Java bytecode references to a Java class file's constant pool and to attributes are replaced by direct references to the corresponding constant pool entries. This facilitates developing analyses and fosters comprehension.
Based on the fact that indirect references to constant pool entries are resolved and replaced by direct references this representation is called the resolved representation.
This representation of Java bytecode is considered as OPAL's standard representation for writing Scala based analyses. This representation is engineered such that it facilitates writing analyses that use pattern matching.
Definition Classes
opalj
package analyses
Defines commonly useful type aliases.
Defines commonly useful type aliases.
Definition Classes
br
package cfg
Definition Classes
br
package collection
Definition Classes
br
package cp
Implementation of classes to represent/recreate a class file's constant pool.
Implementation of classes to represent/recreate a class file's constant pool.
Definition Classes
br
package fpcf
Definition Classes
br
package instructions
Common instruction sequences.
Common instruction sequences.
Definition Classes
br
package reader
Defines convenience methods related to reading in class files.
Defines convenience methods related to reading in class files.
Definition Classes
br
Annotation
AnnotationLike
AnnotationTable
AnnotationValue
AppendFrame
ArrayElementType
ArrayType
ArrayTypeSignature
ArrayValue
Attribute
BaseType
BaseTypeElementValue
BasicClassTypeSignature
BooleanType
BooleanValue
BootstrapArgument
BootstrapMethod
BootstrapMethodTable
ByteType
ByteValue
CTIntType
Category1ComputationalTypeCategory
Category2ComputationalTypeCategory
CharType
CharValue
ChopFrame
ChopFrame248
ChopFrame249
ChopFrame250
ClassFile
ClassFileAttributeBuilder
ClassFileRepository
ClassHierarchy
ClassMember
ClassSignature
ClassTypeSignature
ClassValue
Code
CodeAnalysisFailedException
CodeAttribute
CodeAttributeBuilder
CodeSequence
CommonAttributes
CommonSourceElementAttributes
CompactLineNumberTable
CompareAllConfiguration
ComputationalType
ComputationalTypeCategory
ComputationalTypeDouble
ComputationalTypeFloat
ComputationalTypeInt
ComputationalTypeLong
ComputationalTypeReference
ComputationalTypeReturnAddress
ConcreteSourceElement
ConcreteType
ConcreteTypeArgument
ConstantClass
ConstantDouble
ConstantFieldValue
ConstantFloat
ConstantInteger
ConstantLong
ConstantString
ConstantValue
ContravariantIndicator
CovariantIndicator
DeclaredMethod
DefinedMethod
Deprecated
DoubleType
DoubleValue
DoubleVariableInfo
DynamicConstant
ElementReferenceType
ElementValue
ElementValuePair
EnclosingMethod
EnumValue
ExceptionHandler
ExceptionTable
Exports
Field
FieldAccessMethodHandle
FieldAttributeBuilder
FieldIdentifier
FieldReadAccessMethodHandle
FieldTemplate
FieldType
FieldTypeJVMSignature
FieldTypeSignature
FieldWriteAccessMethodHandle
FloatType
FloatValue
FloatVariableInfo
FormalTypeParameter
FullFrame
GenericType
GenericTypeArgument
GenericTypeWithClassSuffix
GetFieldMethodHandle
GetStaticMethodHandle
HasNoArgsAndReturnsVoid
InnerClass
InnerClassTable
InstructionsContainer
IntLikeType
IntValue
IntegerType
IntegerVariableInfo
InvokeInterfaceMethodHandle
InvokeSpecialMethodHandle
InvokeStaticMethodHandle
InvokeVirtualMethodHandle
JVMField
JVMMethod
JVMMethodDescriptor
LineNumber
LineNumberTable
LocalVariable
LocalVariableTable
LocalVariableType
LocalVariableTypeTable
LocalvarTableEntry
LongType
LongValue
LongVariableInfo
LowerTypeBound
Method
MethodAttributeBuilder
MethodCallMethodHandle
MethodDescriptor
MethodHandle
MethodIdentifier
MethodParameter
MethodParameterTable
MethodSignature
MethodTemplate
MethodTypeSignature
MethodWithBody
Module
ModuleMainClass
ModulePackages
MultipleDefinedMethods
NestHost
NestMembers
NewInvokeSpecialMethodHandle
NoArgumentMethodDescriptor
NoSourceElementsVisitor
NotJavaLangObject
NotVoid
NullVariableInfo
NumericType
ObjectType
ObjectVariableInfo
Opens
PCAndAnyRef
PCAndInstruction
PCInMethod
ParameterAnnotationTable
PermittedSubclasses
ProperTypeArgument
Provides
PutFieldMethodHandle
PutStaticMethodHandle
Record
RecordComponent
ReferenceType
Requires
ReturnType
ReturnTypeSignature
RuntimeInvisibleAnnotationTable
RuntimeInvisibleParameterAnnotationTable
RuntimeInvisibleTypeAnnotationTable
RuntimeVisibleAnnotationTable
RuntimeVisibleParameterAnnotationTable
RuntimeVisibleTypeAnnotationTable
SameFrame
SameFrameExtended
SameLocals1StackItemFrame
SameLocals1StackItemFrameExtended
ShortType
ShortValue
Signature
SignatureElement
SignatureVisitor
SimilarityTestConfiguration
SimpleClassTypeSignature
SimpleGenericType
SingleArgumentMethodDescriptor
SourceDebugExtension
SourceElement
SourceElementsVisitor
SourceFile
StackMapFrame
StackMapTable
StringValue
StructureIdentifier
SubtypeInformation
SupertypeInformation
SynthesizedClassFiles
Synthetic
TADeeperInArrayType
TADeeperInNestedType
TADirectlyOnType
TAOfCastExpression
TAOfCatch
TAOfConstructorInMethodReferenceExpression
TAOfConstructorInvocation
TAOfFieldDeclaration
TAOfFormalParameter
TAOfInstanceOf
TAOfLocalvarDecl
TAOfMethodInMethodReferenceExpression
TAOfMethodInvocation
TAOfMethodReferenceExpressionIdentifier
TAOfMethodReferenceExpressionNew
TAOfNew
TAOfParameterDeclarationOfClassOrInterface
TAOfParameterDeclarationOfMethodOrConstructor
TAOfReceiverType
TAOfResourcevarDecl
TAOfReturnType
TAOfSupertype
TAOfThrows
TAOfTypeBoundOfParameterDeclarationOfClassOrInterface
TAOfTypeBoundOfParameterDeclarationOfMethodOrConstructor
TAOnBoundOfWildcardType
TAOnNestedType
TAOnTypeArgument
TheArgument
ThrowsSignature
TopVariableInfo
TraversingVisitor
TwoArgumentsMethodDescriptor
Type
TypeAnnotation
TypeAnnotationPath
TypeAnnotationPathElement
TypeAnnotationTable
TypeAnnotationTarget
TypeAnnotationTargetInClassDeclaration
TypeAnnotationTargetInCode
TypeAnnotationTargetInFieldDeclaration
TypeAnnotationTargetInMetodDeclaration
TypeAnnotationTargetInVarDecl
TypeArgument
TypeConversionFactory
TypeDeclaration
TypeHierarchyInformation
TypeIdentifier
TypeSignature
TypeVariableSignature
TypesVisitor
UninitializedThisVariableInfo
UninitializedVariableInfo
UnknownAttribute
UnpackedLineNumberTable
UpperTypeBound
VarianceIndicator
VerificationTypeInfo
VirtualClass
VirtualClassMember
VirtualDeclaredMethod
VirtualField
VirtualForwardingMethod
VirtualMethod
VirtualSourceElement
VirtualTypeFlag
VoidType
Wildcard

org.opalj.br

CommonAttributes

trait CommonAttributes extends AnyRef

Defines methods to return common attributes from the attributes table of ClassFile, Field, Method and Code declarations.

Source: CommonAttributes.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

ClassFile, ClassMember, Code, CommonSourceElementAttributes, ConcreteSourceElement, Field, FieldTemplate, JVMField, JVMMethod, Method, MethodTemplate, SourceElement, VirtualClass, VirtualClassMember, VirtualField, VirtualForwardingMethod, VirtualMethod, VirtualSourceElement

Ordering

Alphabetic
By Inheritance

Inherited

CommonAttributes
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def attributes: Attributes

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
def compareAttributes(other: Attributes, config: SimilarityTestConfiguration): Option[AnyRef]
Compares this element's attributes with the given one.
Compares this element's attributes with the given one.
returns
None, if both attribute lists are similar; Some(<description of the difference>) otherwise.
Attributes
protected[this]
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def foreachTypeAnnotation[U](f: (TypeAnnotation) => U): Unit
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
def runtimeInvisibleTypeAnnotations: TypeAnnotations
def runtimeVisibleTypeAnnotations: TypeAnnotations
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated

Ungrouped

abstract def attributes: Attributes
final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
def compareAttributes(other: Attributes, config: SimilarityTestConfiguration): Option[AnyRef]
Compares this element's attributes with the given one.
Compares this element's attributes with the given one.
returns
None, if both attribute lists are similar; Some(<description of the difference>) otherwise.
Attributes
protected[this]
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def foreachTypeAnnotation[U](f: (TypeAnnotation) => U): Unit
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
def runtimeInvisibleTypeAnnotations: TypeAnnotations
def runtimeVisibleTypeAnnotations: TypeAnnotations
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated

Packages

General Design Decisions

Thread Safety

No `null` Values

No Typecasts for Collections

Assertions

CommonAttributes

trait CommonAttributes extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

CommonAttributes

trait CommonAttributes extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

No `null` Values

CommonAttributes