org.netbeans.api.java.source.support

Class ReferencesCount

java.lang.Object

org.netbeans.api.java.source.support.ReferencesCount

public final class ReferencesCount
extends Object

Provides an information about frequencies of type and package usages in given source root or source path.

Since:

0.97

Method Summary

Modifier and Type	Method and Description
static ReferencesCount	get(ClasspathInfo cpInfo) Creates a ReferencesCount for source classpath represented by given ClasspathInfo.
static ReferencesCount	get(URL root) Creates a ReferencesCount for source root.
int	getPackageReferenceCount(ElementHandle<? extends PackageElement> pkg) Returns an estimate of a number of classes on given source path (source root) which are using given package.
int	getTypeReferenceCount(ElementHandle<? extends TypeElement> type) Returns an estimate of a number of classes on given source path (source root) which are using given type.
Iterable<? extends ElementHandle<? extends PackageElement>>	getUsedPackages() Returns all packages used by classes on given source path (source root).
Iterable<? extends ElementHandle<? extends TypeElement>>	getUsedTypes() Returns all types used by classes on given source path (source root).

Methods inherited from class java.lang.Object

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

Method Detail

getTypeReferenceCount

public int getTypeReferenceCount(@NonNull
                                 ElementHandle<? extends TypeElement> type)

Returns an estimate of a number of classes on given source path (source root) which are using given type.

Parameters:

type - the type type to find the usage frequency for.

Returns:

number of classes using the type.

getPackageReferenceCount

public int getPackageReferenceCount(@NonNull
                                    ElementHandle<? extends PackageElement> pkg)

Returns an estimate of a number of classes on given source path (source root) which are using given package.

Parameters:

pkg - the package to find the usage frequency for.

Returns:

number of classes using types from given package.

getUsedTypes

@NonNull
public Iterable<? extends ElementHandle<? extends TypeElement>> getUsedTypes()

Returns all types used by classes on given source path (source root).

Returns:

the used classes

getUsedPackages

@NonNull
public Iterable<? extends ElementHandle<? extends PackageElement>> getUsedPackages()

Returns all packages used by classes on given source path (source root).

Returns:

the used packages

get

@NonNull
public static ReferencesCount get(@NonNull
                                           ClasspathInfo cpInfo)

Creates a ReferencesCount for source classpath represented by given ClasspathInfo.

Parameters:

cpInfo - the ClasspathInfo to create ReferencesCount for.

Returns:

the ReferencesCount

get

@NonNull
public static ReferencesCount get(@NonNull
                                           URL root)

Creates a ReferencesCount for source root.

Parameters:

root - the root to create ReferencesCount for.

Returns:

the ReferencesCount