Package sootup.core.model

Class SootClassMember<S extends SootClassMemberSignature>

java.lang.Object

sootup.core.model.SootClassMember<S>

All Implemented Interfaces:

HasPosition

Direct Known Subclasses:

JavaSootField, JavaSootMethod

public abstract class SootClassMember<S extends SootClassMemberSignature>
extends Object
implements HasPosition

Provides methods common to Soot objects belonging to classes, namely SootField and SootMethod.

Author:

Linghui Luo, Jan Martin Persch

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull Position	position
protected final @NonNull S	signature

Constructor Summary

Constructors

Constructor	Description
SootClassMember(@NonNull S signature, @NonNull Position position)

Method Summary

Modifier and Type	Method	Description
abstract int	equivHashCode()	Returns a hash code for this method consistent with structural equality.
@NonNull ClassType	getDeclaringClassType()	Returns the SootClass declaring this one.
@NonNull String	getName()
@NonNull Position	getPosition()	Line and column information of the corresponding code object that this represents.
@NonNull S	getSignature()	Returns the Soot signature of this method.
abstract boolean	isFinal()	Convenience method returning true if this field is final.
abstract boolean	isPrivate()	Convenience method returning true if this class member is private.
abstract boolean	isProtected()	Convenience method returning true if this class member is protected.
abstract boolean	isPublic()	Convenience method returning true if this class member is public.
abstract boolean	isStatic()	Convenience method returning true if this class member is static.
@NonNull String	toString()	Returns the signature of this method.

Methods inherited from class java.lang.Object

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

Field Details

signature

protected final @NonNull S extends SootClassMemberSignature signature

position

protected final @NonNull Position position

Constructor Details

SootClassMember

public SootClassMember(@NonNull S signature,
 @NonNull Position position)

Method Details

getDeclaringClassType

public @NonNull ClassType getDeclaringClassType()

Returns the SootClass declaring this one.

isProtected

public abstract boolean isProtected()

Convenience method returning true if this class member is protected.

isPrivate

public abstract boolean isPrivate()

Convenience method returning true if this class member is private.

isPublic

public abstract boolean isPublic()

Convenience method returning true if this class member is public.

isStatic

public abstract boolean isStatic()

Convenience method returning true if this class member is static.

isFinal

public abstract boolean isFinal()

Convenience method returning true if this field is final.

equivHashCode

public abstract int equivHashCode()

Returns a hash code for this method consistent with structural equality.

toString

public @NonNull String toString()

Returns the signature of this method.

Overrides:

toString in class Object

getSignature

public @NonNull S getSignature()

Returns the Soot signature of this method. Used to refer to methods unambiguously.

getName

public @NonNull String getName()

getPosition

public @NonNull Position getPosition()

Description copied from interface: HasPosition

Line and column information of the corresponding code object that this represents.

Specified by:

getPosition in interface HasPosition

Returns:

a Position containing position information.