JarEntry (WebLaF core library 1.2.13 API)

java.lang.Object
- com.alee.utils.jar.JarEntry

All Implemented Interfaces:

Identifiable
```
public class JarEntry
extends Object
implements Identifiable
```
This class represents single JAR file structure element. It might contain other nested JarEntry.

Author:

Mikle Garin

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<JarEntry>`	`children` Children JAR entries.
`protected Icon`	`icon` Custom JAR entry icon.
`protected String`	`id` Unique JAR entry ID.
`protected static String`	`ID_PREFIX` ID prefix.
`protected String`	`name` JAR entry name.
`protected JarEntry`	`parent` Parent JAR entry if it has one.
`protected JarStructure`	`structure` JAR structure this entry belongs to.
`protected JarEntryType`	`type` JAR entry type.
`protected ZipEntry`	`zipEntry` ZIP entry reference for this JAR entry.

Constructor Summary

Constructors
Constructor and Description
`JarEntry(JarStructure structure, JarEntryType type, String name)` Constructs new `JarEntry`.
`JarEntry(JarStructure structure, JarEntry parent, ZipEntry zipEntry, JarEntryType type, String name)` Constructs new `JarEntry`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(JarEntry child)` Adds child `JarEntry`.
`boolean`	`equals(Object other)`
`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.
`String`	`getCanonicalEntryName()` Returns `JarEntry` canonical name.
`String`	`getCanonicalEntryPath()` Returns `JarEntry` canonical path.
`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>`	`getChildren()` Returns copy of children `JarEntry`s.
`String`	`getEntryExtension()` Returns `JarEntry` file extension if it is a file, empty `String` othewise.
`Icon`	`getIcon()` Returns `JarEntry` icon.
`String`	`getId()` Returns unique object identifier.
`InputStream`	`getInputStream()` Returns `JarEntry` content `InputStream`.
`String`	`getName()` Returns `JarEntry` name.
`JarEntry`	`getParent()` Returns parent `JarEntry` or `null` if this is a `JarEntryType.JAR` entry.
`List<JarEntry>`	`getPath()` Returns `List` of `JarEntry`s representing this `JarEntry` path to root `JarEntry`.
`JarEntryType`	`getType()` Returns `JarEntryType`.
`ZipEntry`	`getZipEntry()` Returns `ZipEntry` or `null` if this is a `JarEntryType.JAR` entry.
`boolean`	`isClassEntry(Class classType)` Returns whether or not this `JarEntry` represents specified `Class`.
`void`	`removeChild(JarEntry child)` Removes child `JarEntry`.
`void`	`setIcon(Icon icon)` Sets custom `JarEntry` icon.
`void`	`setName(String name)` Sets custom `JarEntry` name.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ID_PREFIX
```
protected static final String ID_PREFIX
```
    ID prefix.
    
    See Also:
    
    Constant Field Values
  - id
```
@NotNull
protected final String id
```
    Unique JAR entry ID.
  - structure
```
@NotNull
protected final JarStructure structure
```
    JAR structure this entry belongs to.
  - parent
```
@Nullable
protected final JarEntry parent
```
    Parent JAR entry if it has one.
  - zipEntry
```
@Nullable
protected final ZipEntry zipEntry
```
    ZIP entry reference for this JAR entry.
  - type
```
@NotNull
protected final JarEntryType type
```
    JAR entry type.
  - name
```
@NotNull
protected String name
```
    JAR entry name.
  - icon
```
@Nullable
protected Icon icon
```
    Custom JAR entry icon.
  - children
```
@Nullable
protected List<JarEntry> children
```
    Children JAR entries.
- Constructor Detail
  - JarEntry
```
public JarEntry(@NotNull
                JarStructure structure,
                @NotNull
                JarEntryType type,
                @NotNull
                String name)
```
    Constructs new JarEntry.
    
    Parameters:
    
    structure - JarStructure
    
    type - JarEntryType
    
    name - JarEntry name
  - JarEntry
```
public JarEntry(@NotNull
                JarStructure structure,
                @Nullable
                JarEntry parent,
                @Nullable
                ZipEntry zipEntry,
                @NotNull
                JarEntryType type,
                @NotNull
                String name)
```
    Constructs new JarEntry.
    
    Parameters:
    
    structure - JarStructure
    
    parent - parent JarEntry
    
    zipEntry - ZipEntry
    
    type - JarEntryType
    
    name - JarEntry name
- Method Detail
  - getId
```
@NotNull
public String getId()
```
    Description copied from interface: Identifiable
    
    Returns unique object identifier. todo Probably change back to NotNull in future
    
    Specified by:
    
    getId in interface Identifiable
    
    Returns:
    
    unique object identifier
  - getParent
```
@Nullable
public JarEntry getParent()
```
    Returns parent JarEntry or null if this is a JarEntryType.JAR entry.
    
    Returns:
    
    parent JarEntry or null if this is a JarEntryType.JAR entry
  - getZipEntry
```
@Nullable
public ZipEntry getZipEntry()
```
    Returns ZipEntry or null if this is a JarEntryType.JAR entry.
    
    Returns:
    
    ZipEntry or null if this is a JarEntryType.JAR entry
  - getType
```
@NotNull
public JarEntryType getType()
```
    Returns JarEntryType.
    
    Returns:
    
    JarEntryType
  - getName
```
@NotNull
public String getName()
```
    Returns JarEntry name.
    
    Returns:
    
    JarEntry name
  - setName
```
public void setName(@NotNull
                    String name)
```
    Sets custom JarEntry name.
    
    Parameters:
    
    name - custom JarEntry name
  - getIcon
```
@NotNull
public Icon getIcon()
```
    Returns JarEntry icon.
    
    Returns:
    
    JarEntry icon
  - setIcon
```
public void setIcon(@Nullable
                    Icon icon)
```
    Sets custom JarEntry icon.
    
    Parameters:
    
    icon - custom JarEntry icon
  - getChildren
```
@NotNull
public List<JarEntry> getChildren()
```
    Returns copy of children JarEntrys.
    
    Returns:
    
    copy of children JarEntrys
  - 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
  - addChild
```
public void addChild(@NotNull
                     JarEntry child)
```
    Adds child JarEntry.
    
    Parameters:
    
    child - child JarEntry to add
  - removeChild
```
public void removeChild(@NotNull
                        JarEntry child)
```
    Removes child JarEntry.
    
    Parameters:
    
    child - child JarEntry to remove
  - getEntryExtension
```
@NotNull
public String getEntryExtension()
```
    Returns JarEntry file extension if it is a file, empty String othewise.
    
    Returns:
    
    JarEntry file extension if it is a file, empty String othewise
  - isClassEntry
```
public boolean isClassEntry(@Nullable
                            Class classType)
```
    Returns whether or not this JarEntry represents specified Class.
    
    Parameters:
    
    classType - Class
    
    Returns:
    
    true if this JarEntry represents specified Class, false otherwise
  - getCanonicalEntryName
```
@NotNull
public String getCanonicalEntryName()
```
    Returns JarEntry canonical name.
    
    Returns:
    
    JarEntry canonical name
  - getCanonicalEntryPath
```
@NotNull
public String getCanonicalEntryPath()
```
    Returns JarEntry canonical path.
    
    Returns:
    
    JarEntry canonical path
  - getPath
```
@NotNull
public List<JarEntry> getPath()
```
    Returns List of JarEntrys representing this JarEntry path to root JarEntry. Root will always be at 0 index, this element will always be at the last index.
    
    Returns:
    
    List of JarEntrys representing this JarEntry path to root JarEntry
  - getInputStream
```
@NotNull
public InputStream getInputStream()
```
    Returns JarEntry content InputStream.
    
    Returns:
    
    JarEntry content InputStream
  - equals
```
public boolean equals(@Nullable
                      Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
@NotNull
public String toString()
```
    Overrides:
    
    toString in class Object

Class JarEntry

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID_PREFIX

id

structure

parent

zipEntry

type

name

icon

children

Constructor Detail

JarEntry

JarEntry

Method Detail

getId

getParent

getZipEntry

getType

getName

setName

getIcon

setIcon

getChildren

getChildByName

getChildByName

findChildByName

findChildByName

addChild

removeChild

getEntryExtension

isClassEntry

getCanonicalEntryName

getCanonicalEntryPath

getPath

getInputStream

equals

toString