Top Description Inners Fields Constructors Methods
org.apache.commons.compress.changes

pack-priv final Class Change<E extends org.apache.commons.compress.archivers.ArchiveEntry>

extends Object
Class Inheritance
Type Parameters
<E>
The ArchiveEntry type.
Imports
java.io.InputStream, java.util.Objects, org.apache.commons.compress.archivers.ArchiveEntry
Change holds meta information about a change.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static enum
Change.ChangeType

Enumerates types of changes.

Field Summary

Modifier and TypeField and Description
private final E
entry

New entry to add.

private final InputStream
inputStream

Source for new entry.

private final boolean
replaceMode

Change should replaceMode existing entries.

private final String
targetFileName

Entry name to delete.

private final Change.ChangeType
type

Type of change.

Constructor Summary

AccessConstructor and Description
pack-priv
Change(final E
the entry details
archiveEntry, final InputStream
the InputStream for the entry data
inputStream, final boolean replace)

Constructs a change which adds an entry.

pack-priv
Change(final String
the file name of the file to delete
fileName, final Change.ChangeType type)

Constructs a new instance.

Method Summary

Modifier and TypeMethod and Description
pack-priv E
getEntry()

pack-priv InputStream
getInputStream()

pack-priv String
getTargetFileName()

pack-priv Change.ChangeType
getType()

pack-priv boolean
isReplaceMode()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

entryback to summary
private final E entry

New entry to add.

inputStreamback to summary
private final InputStream inputStream

Source for new entry.

replaceModeback to summary
private final boolean replaceMode

Change should replaceMode existing entries.

targetFileNameback to summary
private final String targetFileName

Entry name to delete.

typeback to summary
private final Change.ChangeType type

Type of change.

Constructor Detail

Changeback to summary
pack-priv Change(final E archiveEntry, final InputStream inputStream, final boolean replace)

Constructs a change which adds an entry.

Parameters
archiveEntry:E

the entry details

inputStream:InputStream

the InputStream for the entry data

Changeback to summary
pack-priv Change(final String fileName, final Change.ChangeType type)

Constructs a new instance. Takes the file name of the file to be deleted from the stream as argument.

Parameters
fileName:String

the file name of the file to delete

Method Detail

getEntryback to summary
pack-priv E getEntry()
getInputStreamback to summary
pack-priv InputStream getInputStream()
getTargetFileNameback to summary
pack-priv String getTargetFileName()
getTypeback to summary
pack-priv Change.ChangeType getType()
isReplaceModeback to summary
pack-priv boolean isReplaceMode()
org.apache.commons.compress.changes back to summary

pack-priv final Enum Change.ChangeType

extends Enum<Change.ChangeType>
Class Inheritance
Enumerates types of changes.

Field Summary

Modifier and TypeField and Description
public static final Change.ChangeType
ADD

Add.

public static final Change.ChangeType
DELETE

Delete.

public static final Change.ChangeType
DELETE_DIR

Delete directory.

public static final Change.ChangeType
MOVE

Not used.

Constructor Summary

AccessConstructor and Description
private
ChangeType()

Method Summary

Modifier and TypeMethod and Description
public static Change.ChangeType
valueOf(String name)

public static Change.ChangeType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ADDback to summary
public static final Change.ChangeType ADD

Add.

DELETEback to summary
public static final Change.ChangeType DELETE

Delete.

DELETE_DIRback to summary
public static final Change.ChangeType DELETE_DIR

Delete directory.

MOVEback to summary
public static final Change.ChangeType MOVE

Not used.

Constructor Detail

ChangeTypeback to summary
private ChangeType()

Method Detail

valueOfback to summary
public static Change.ChangeType valueOf(String name)
valuesback to summary
public static Change.ChangeType[] values()