OpenJDK 1.23 · com.sun.tools.jdeps.Archive · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
pack-priv static interface	Archive.Visitor

Modifier and Type	Field and Description
protected Map<Dependency.Location, Set<Dependency.Location>>	deps
private final String	filename
private final URI	location
private final Path	path
private final ClassFileReader	reader

Access	Constructor and Description
protected	Archive(String name)
protected	Archive(String name, URI location, ClassFileReader reader)
protected	Archive(Path p, ClassFileReader reader)

Method Summary

Modifier and Type	Method and Description
public void	addClass(Dependency.Location origin)
public void	addClass(Dependency.Location origin, Dependency.Location target)
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public boolean	contains(String entry)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Set<Dependency.Location>	getClasses()
public Stream<Dependency.Location>	getDependencies()
public static Archive	getInstance(Path p, Runtime.Version version)
public Module	getModule()
public String	getName()
public String	getPathName()
public boolean	hasDependences()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEmpty() Tests if any class has been parsed.
private boolean	isJrt()
public static boolean	isSameLocation(Archive archive, Archive other)
public Optional<Path>	path()
public ClassFileReader	reader()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	visitDependences(Archive.Visitor v)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

deps	back to summary
protected Map<Dependency.Location, Set<Dependency.Location>> deps

filename	back to summary
private final String filename

location	back to summary
private final URI location

path	back to summary
private final Path path

reader	back to summary
private final ClassFileReader reader

Archive	back to summary
protected Archive(String name)

Archive	back to summary
protected Archive(String name, URI location, ClassFileReader reader)

Archive	back to summary
protected Archive(Path p, ClassFileReader reader)

Method Detail

addClass	back to summary
public void addClass(Dependency.Location origin)

addClass	back to summary
public void addClass(Dependency.Location origin, Dependency.Location target)

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

contains	back to summary
public boolean contains(String entry)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getClasses	back to summary
public Set<Dependency.Location> getClasses()

getDependencies	back to summary
public Stream<Dependency.Location> getDependencies()

getInstance	back to summary
public static Archive getInstance(Path p, Runtime.Version version)

getModule	back to summary
public Module getModule()

getName	back to summary
public String getName()

getPathName	back to summary
public String getPathName()

hasDependences	back to summary
public boolean hasDependences()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isEmpty	back to summary
public boolean isEmpty() Tests if any class has been parsed.

isJrt	back to summary
private boolean isJrt()

isSameLocation	back to summary
public static boolean isSameLocation(Archive archive, Archive other)

path	back to summary
public Optional<Path> path()

reader	back to summary
public ClassFileReader reader()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations