Class SplitArchiveSaveOptions
- java.lang.Object
-
- com.aspose.zip.SplitArchiveSaveOptions
-
public class SplitArchiveSaveOptions extends Object
Options for saving a multi-volume ZIP archive.
-
-
Constructor Summary
Constructors Constructor Description SplitArchiveSaveOptions(String fileName, long segmentSize)Instantiates settings for saving a multi-volume ZIP archive.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetArchiveComment()Gets optional comment for the Zip file.booleangetCloseEntrySource()Gets a value indicating whether entries' sources should be closed right after an entry has been compressed.CharsetgetEncoding()Gets encoding for converting file names and other strings to bytes.EventsBaggetEventsBag()Gets container of events raising on archive saving.StringgetFileName()Gets the name of segments without extension.longgetSegmentSize()Gets the size of the segment.voidsetArchiveComment(String value)Sets optional comment for the Zip file.voidsetCloseEntrySource(boolean value)Sets a value indicating whether entries' sources should be closed right after an entry has been compressed.voidsetEncoding(Charset value)Sets encoding for converting file names and other strings to bytes.voidsetEventsBag(EventsBag value)Sets container of events raising on archive saving.
-
-
-
Constructor Detail
-
SplitArchiveSaveOptions
public SplitArchiveSaveOptions(String fileName, long segmentSize)
Instantiates settings for saving a multi-volume ZIP archive.
Some volumes may be less than
segmentSize. In most cases, the last segment will be less but rarely regular segments might be too.Names of files will be as follows:
fileName.z01,fileName.z02, ...,fileName.z(n-1),fileName.zip.- Parameters:
fileName- Name for volumes. May be with or without .zip extension.segmentSize- Size of volume.- Throws:
com.aspose.ms.System.ArgumentOutOfRangeException- Segment size is less than 65536 bytes.
-
-
Method Detail
-
getSegmentSize
public final long getSegmentSize()
Gets the size of the segment.
- Returns:
- the size of the segment.
-
getFileName
public final String getFileName()
Gets the name of segments without extension.
- Returns:
- the name of segments without extension.
-
getArchiveComment
public final String getArchiveComment()
Gets optional comment for the Zip file.
- Returns:
- optional comment for the Zip file.
-
setArchiveComment
public final void setArchiveComment(String value)
Sets optional comment for the Zip file.
- Parameters:
value- optional comment for the Zip file.
-
getEncoding
public final Charset getEncoding()
Gets encoding for converting file names and other strings to bytes.
If not set, code page 437 will be used.
- Returns:
- encoding for converting file names and other strings to bytes.
-
setEncoding
public final void setEncoding(Charset value)
Sets encoding for converting file names and other strings to bytes.
If not set, code page 437 will be used.
- Parameters:
value- encoding for converting file names and other strings to bytes.
-
getCloseEntrySource
public final boolean getCloseEntrySource()
Gets a value indicating whether entries' sources should be closed right after an entry has been compressed.
- Returns:
- a value indicating whether entries' sources should be closed right after an entry has been compressed.
-
setCloseEntrySource
public final void setCloseEntrySource(boolean value)
Sets a value indicating whether entries' sources should be closed right after an entry has been compressed.
- Parameters:
value- a value indicating whether entries' sources should be closed right after an entry has been compressed.
-
getEventsBag
public final EventsBag getEventsBag()
Gets container of events raising on archive saving.
- Returns:
- container of events raising on archive saving.
-
setEventsBag
public final void setEventsBag(EventsBag value)
Sets container of events raising on archive saving.
- Parameters:
value- container of events raising on archive saving.
-
-