edu.umd.cs.findbugs.ba.jsr305

Class SourceSinkInfo

java.lang.Object

edu.umd.cs.findbugs.ba.jsr305.SourceSinkInfo

All Implemented Interfaces:

java.lang.Comparable<SourceSinkInfo>

public class SourceSinkInfo
extends java.lang.Object
implements java.lang.Comparable<SourceSinkInfo>

Information about a source or sink in the type qualifier dataflow analysis.

Author:

David Hovemeyer

Constructor Summary

Constructors

Constructor and Description
SourceSinkInfo(SourceSinkType type, Location location, ValueNumber vn, javax.annotation.meta.When when) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(SourceSinkInfo o)
boolean	equals(java.lang.Object obj)
java.lang.Object	getConstantValue()
boolean	getInterproc() Return whether or not the SourceSinkInfo was created based on the results of type qualifiers computed for a called method (and not explicitly annotating the called method).
int	getLocal()
Location	getLocation()
int	getParameter()
SourceSinkType	getType()
ValueNumber	getValueNumber()
javax.annotation.meta.When	getWhen()
int	hashCode()
void	setConstantValue(java.lang.Object constantValue)
void	setInterproc(boolean interproc) Set the SourceSinkInfo as having been created based on the results of type qualifiers computed for a called method (and not explicitly annotating the called method).
void	setParameter(int parameter)
void	setParameterAndLocal(int parameter, int local)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SourceSinkInfo

public SourceSinkInfo(SourceSinkType type,
              Location location,
              ValueNumber vn,
              javax.annotation.meta.When when)

Constructor.

Parameters:

type - type of the source or sink

location - Location of the source or sink

vn - the ValueNumber of the annotated value

when - the When value used (explicitly or implicitly) to annotate this source or sink

Method Detail

getType

public SourceSinkType getType()

Returns:

Returns the type.

getLocation

public Location getLocation()

Returns:

Returns the location.

getValueNumber

public ValueNumber getValueNumber()

Returns:

Returns the ValueNumber.

getWhen

public javax.annotation.meta.When getWhen()

Returns:

Returns the when.

setParameter

public void setParameter(int parameter)

Parameters:

parameter - The parameter to set.

setParameterAndLocal

public void setParameterAndLocal(int parameter,
                        int local)

Parameters:

parameter - The parameter to set.

local - The local to set.

getParameter

public int getParameter()

Returns:

Returns the parameter.

getLocal

public int getLocal()

Returns:

Returns the local.

setInterproc

public void setInterproc(boolean interproc)

Set the SourceSinkInfo as having been created based on the results of type qualifiers computed for a called method (and not explicitly annotating the called method).

Parameters:

interproc - true if the SourceSinkInfo results from computed type qualifiers for a called method, false otherwise

getInterproc

public boolean getInterproc()

Return whether or not the SourceSinkInfo was created based on the results of type qualifiers computed for a called method (and not explicitly annotating the called method).

Returns:

true if the SourceSinkInfo results from computed type qualifiers for a called method, false otherwise

compareTo

public int compareTo(SourceSinkInfo o)

Specified by:

compareTo in interface java.lang.Comparable<SourceSinkInfo>

getConstantValue

public java.lang.Object getConstantValue()

setConstantValue

public void setConstantValue(java.lang.Object constantValue)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object