Package sootup.core.model

Class AbstractClass

java.lang.Object

sootup.core.model.AbstractClass

Direct Known Subclasses:

SootClass

public abstract class AbstractClass
extends Object

Abstract class represents a class/module lives in View. It may have different implementations, since we want to support multiple languages. An abstract class must be uniquely identified by its Signature.

Author:

Linghui Luo

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull SootClassSource	classSource

Constructor Summary

Constructors

Constructor	Description
AbstractClass(@NonNull SootClassSource cs)

Method Summary

Modifier and Type	Method	Description
@NonNull SootClassSource	getClassSource()
@NonNull Optional<? extends SootField>	getField(@NonNull String name)	Returns the field of this class with the given name.
@NonNull Optional<? extends SootField>	getField(@NonNull FieldSubSignature subSignature)	Attemtps to retrieve the field with the given FieldSubSignature.
abstract @NonNull Set<? extends SootField>	getFields()
@NonNull Optional<? extends SootMethod>	getMethod(@NonNull String name, @NonNull Iterable<? extends Type> parameterTypes)	Attempts to retrieve the method with the given name and parameters.
@NonNull Optional<? extends SootMethod>	getMethod(@NonNull MethodSubSignature subSignature)	Attempts to retrieve the method with the given subSignature.
abstract @NonNull Set<? extends SootMethod>	getMethods()
@NonNull Set<? extends SootMethod>	getMethodsByName(@NonNull String name)	Attempts to retrieve the method with the given name.
abstract @NonNull String	getName()
abstract @NonNull Type	getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

classSource

protected final @NonNull SootClassSource classSource

Constructor Details

AbstractClass

public AbstractClass(@NonNull SootClassSource cs)

Method Details

getClassSource

public @NonNull SootClassSource getClassSource()

getName

public abstract @NonNull String getName()

getType

public abstract @NonNull Type getType()

getFields

public abstract @NonNull Set<? extends SootField> getFields()

getMethods

public abstract @NonNull Set<? extends SootMethod> getMethods()

getMethod

public @NonNull Optional<? extends SootMethod> getMethod(@NonNull MethodSubSignature subSignature)

Attempts to retrieve the method with the given subSignature. This method may throw an AmbiguousStateException if there are more than one method with the given subSignature. If no method with the given is found, null is returned.

getField

public @NonNull Optional<? extends SootField> getField(@NonNull FieldSubSignature subSignature)

Attemtps to retrieve the field with the given FieldSubSignature.

getField

public @NonNull Optional<? extends SootField> getField(@NonNull String name)

Returns the field of this class with the given name. Throws a ResolveException if there is more than one field with the given name. Returns null if no field with the given name exists.

getMethod

public @NonNull Optional<? extends SootMethod> getMethod(@NonNull String name,
 @NonNull Iterable<? extends Type> parameterTypes)

Attempts to retrieve the method with the given name and parameters. This method may throw an ResolveException if there is more than one method with the given name and parameter.

getMethodsByName

public @NonNull Set<? extends SootMethod> getMethodsByName(@NonNull String name)

Attempts to retrieve the method with the given name. This method will return an empty Set if there is no method with the given name.

Parameters:

name - the name of the method

Returns:

a set of methods that have the given name