com.google.cloud.tools.opensource.classpath

Class LinkageProblem

java.lang.Object

com.google.cloud.tools.opensource.classpath.LinkageProblem

Direct Known Subclasses:

ClassNotFoundProblem, SymbolNotFoundProblem

public abstract class LinkageProblem
extends Object

A linkage error describing an invalid reference from sourceClass to symbol.

See Also:

Java Dependency Glossary: Linkage Error

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static String	formatLinkageProblems(Set<LinkageProblem> linkageProblems, ClassPathResult classPathResult) Returns the formatted linkageProblems by grouping them by the symbols.
String	formatSymbolProblem() Returns the description of the problem on the symbol.
protected String	formatSymbolProblemWithReferenceCount(int referenceCount)
ClassFile	getSourceClass() Returns the class that contains a symbolic reference to a symbol that is not available.
Symbol	getSymbol() Returns the symbol that was not resolved.
ClassFile	getTargetClass() Returns the class that is expected to contain the symbol.
static com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSet<String>>	groupBySymbolProblem(Iterable<LinkageProblem> linkageProblems) Returns mapping from symbol problem description to the names of the source classes.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getSymbol

public Symbol getSymbol()

Returns the symbol that was not resolved.

getSourceClass

public ClassFile getSourceClass()

Returns the class that contains a symbolic reference to a symbol that is not available.

getTargetClass

@Nullable
public ClassFile getTargetClass()

Returns the class that is expected to contain the symbol. If the symbol is a method or a field, then this is the class where the symbol was expected to be found. If the symbol is an inner class, this is the outer class that was expected to contain the inner class. If the symbol is an outer class that is unknown or missing, this is null.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

formatSymbolProblem

public String formatSymbolProblem()

Returns the description of the problem on the symbol. This description does not include the sourceClass. This value is useful when grouping LinkageProblems by their symbols.

formatSymbolProblemWithReferenceCount

protected String formatSymbolProblemWithReferenceCount(int referenceCount)

groupBySymbolProblem

public static com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSet<String>> groupBySymbolProblem(Iterable<LinkageProblem> linkageProblems)

Returns mapping from symbol problem description to the names of the source classes.

formatLinkageProblems

public static String formatLinkageProblems(Set<LinkageProblem> linkageProblems,
                                           @Nullable
                                           ClassPathResult classPathResult)

Returns the formatted linkageProblems by grouping them by the symbols. If classPathResult is not null, it supplies dependency paths from the root to the artifacts in the problems.