com.alee.utils.jar

Class JarStructure

java.lang.Object

com.alee.utils.jar.JarStructure

public class JarStructure
extends Object

This class represents single JAR file structure. It might be really useful to navigate through JAR

Author:

Mikle Garin

Field Summary

Fields

Modifier and Type	Field and Description
protected String	jarLocation Location of JAR file which structure is represented by this object.
protected JarEntry	root Root JarEntry.

Constructor Summary

Constructors

Constructor and Description
JarStructure(Class jarClass) Constructs new JarStructure.
JarStructure(Class jarClass, List<String> allowedExtensions, List<String> allowedPackages) Constructs new JarStructure.
JarStructure(Class jarClass, List<String> allowedExtensions, List<String> allowedPackages, FileDownloadListener listener) Constructs new JarStructure.

Method Summary

Modifier and Type	Method and Description
JarEntry	findChildByName(String name) Returns child JarEntry with the specfiied name or null if it cannot be found.
JarEntry	findChildByName(String name, boolean recursively) Returns child JarEntry with the specfiied name or null if it cannot be found.
JarEntry	getChildByName(String name) Returns child JarEntry with the specfiied name or null if it cannot be found.
JarEntry	getChildByName(String name, boolean recursively) Returns child JarEntry with the specfiied name or null if it cannot be found.
List<JarEntry>	getChildEntries() Returns copy of children JarEntrys of the root JarEntry.
JarEntry	getClassEntry(Class<?> forClass) Returns JarEntry for the specified Class or null if it cannot be found.
String	getJarLocation() Returns JAR file location.
JarEntry	getPackageEntry(Package forPackage) Returns JarEntry for the specified Package or null if it cannot be found.
JarEntry	getPackageEntry(String forPackage) Returns JarEntry for the specified Package name or null if it cannot be found.
JarEntry	getRoot() Returns root JarEntry of JarEntryType.JAR representing JAR itself.
void	setClassIcon(Class<?> forClass, Icon icon) Sets Icon for the JarEntry representing specified Class.
void	setPackageIcon(Package forPackage, Icon icon) Sets Icon for the JarEntry representing specified Package.
void	setPackageIcon(String forPackage, Icon icon) Sets Icon for the JarEntry representing specified Package name.

Methods inherited from class java.lang.Object

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

Field Detail

jarLocation

@NotNull
protected final String jarLocation

Location of JAR file which structure is represented by this object. Since local copy of file is always required to create this structure this field always points at existing local JAR file.

root

@NotNull
protected final JarEntry root

Root JarEntry. Represents JAR structure itself using nested JarEntry.

Constructor Detail

JarStructure

public JarStructure(@NotNull
                    Class jarClass)

Constructs new JarStructure.

Parameters:

jarClass - any class within the JAR

JarStructure

public JarStructure(@NotNull
                    Class jarClass,
                    @Nullable
                    List<String> allowedExtensions,
                    @Nullable
                    List<String> allowedPackages)

Constructs new JarStructure.

Parameters:

jarClass - any class within the JAR

allowedExtensions - list of extension filters

allowedPackages - list of allowed packages

JarStructure

public JarStructure(@NotNull
                    Class jarClass,
                    @Nullable
                    List<String> allowedExtensions,
                    @Nullable
                    List<String> allowedPackages,
                    @Nullable
                    FileDownloadListener listener)

Constructs new JarStructure.

Parameters:

jarClass - any class within the JAR

allowedExtensions - list of extension filters

allowedPackages - list of allowed packages

listener - FileDownloadListener for JAR file

Method Detail

getJarLocation

@NotNull
public String getJarLocation()

Returns JAR file location.

Returns:

JAR file location

getRoot

@NotNull
public JarEntry getRoot()

Returns root JarEntry of JarEntryType.JAR representing JAR itself.

Returns:

root JarEntry of JarEntryType.JAR representing JAR itself

getChildEntries

@NotNull
public List<JarEntry> getChildEntries()

Returns copy of children JarEntrys of the root JarEntry.

Returns:

copy of children JarEntrys of the root JarEntry

getChildByName

@NotNull
public JarEntry getChildByName(@Nullable
                                        String name)

Returns child JarEntry with the specfiied name or null if it cannot be found.

Parameters:

name - child JarEntry name

Returns:

child JarEntry with the specfiied name or null if it cannot be found

getChildByName

@NotNull
public JarEntry getChildByName(@Nullable
                                        String name,
                                        boolean recursively)

Returns child JarEntry with the specfiied name or null if it cannot be found.

Parameters:

name - child JarEntry name

recursively - whether should look for the child recursively in all children

Returns:

child JarEntry with the specfiied name or null if it cannot be found

findChildByName

@Nullable
public JarEntry findChildByName(@Nullable
                                          String name)

Returns child JarEntry with the specfiied name or null if it cannot be found.

Parameters:

name - child JarEntry name

Returns:

child JarEntry with the specfiied name or null if it cannot be found

findChildByName

@Nullable
public JarEntry findChildByName(@Nullable
                                          String name,
                                          boolean recursively)

Returns child JarEntry with the specfiied name or null if it cannot be found.

Parameters:

name - child JarEntry name

recursively - whether should look for the child recursively in all children

Returns:

child JarEntry with the specfiied name or null if it cannot be found

getClassEntry

@Nullable
public JarEntry getClassEntry(@NotNull
                                        Class<?> forClass)

Returns JarEntry for the specified Class or null if it cannot be found.

Parameters:

forClass - Class to find JarEntry for

Returns:

JarEntry for the specified Class or null if it cannot be found

getPackageEntry

@Nullable
public JarEntry getPackageEntry(@NotNull
                                          Package forPackage)

Returns JarEntry for the specified Package or null if it cannot be found.

Parameters:

forPackage - Package to find JarEntry for

Returns:

JarEntry for the specified Package or null if it cannot be found

getPackageEntry

@Nullable
public JarEntry getPackageEntry(@NotNull
                                          String forPackage)

Returns JarEntry for the specified Package name or null if it cannot be found.

Parameters:

forPackage - Package name to find JarEntry for

Returns:

JarEntry for the specified Package name or null if it cannot be found

setClassIcon

public void setClassIcon(@NotNull
                         Class<?> forClass,
                         @NotNull
                         Icon icon)

Sets Icon for the JarEntry representing specified Class.

Parameters:

forClass - Class to find JarEntry for

icon - Icon

setPackageIcon

public void setPackageIcon(@NotNull
                           Package forPackage,
                           @NotNull
                           Icon icon)

Sets Icon for the JarEntry representing specified Package.

Parameters:

forPackage - Package to find JarEntry for

icon - Icon

setPackageIcon

public void setPackageIcon(@NotNull
                           String forPackage,
                           @NotNull
                           Icon icon)

Sets Icon for the JarEntry representing specified Package name.

Parameters:

forPackage - Package name to find JarEntry for

icon - Icon