public Class BaseFormat

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.archive.BaseFormat

Known Direct Subclasses

org.eclipse.jgit.archive.TarFormat, org.eclipse.jgit.archive.Tbz2Format, org.eclipse.jgit.archive.TgzFormat, org.eclipse.jgit.archive.TxzFormat, org.eclipse.jgit.archive.ZipFormat

Imports

java.beans.Statement, java.io.IOException, java.text.MessageFormat, java.util.Map, org.apache.commons.compress.archivers.ArchiveEntry, .ArchiveOutputStream, org.eclipse.jgit.archive.internal.ArchiveText, org.eclipse.jgit.util.StringUtils

Base format class

Since: 4.0

Field Summary

Modifier and Type	Field and Description
protected static final String	COMPRESSION_LEVEL Compression-level for the archive file.

Constructor Summary

Access	Constructor and Description
public	BaseFormat()

Method Summary

Modifier and Type	Method and Description
protected ArchiveOutputStream<? extends ArchiveEntry>	Returns: stream with option applied applyFormatOptions(ArchiveOutputStream<? extends ArchiveEntry> stream to apply options to s, Map<String, Object> options map o) Apply options to archive output stream
protected int	Returns: The compression level if it exists in the map, or -1 instead. getCompressionLevel(Map<String, Object> options map o) Removes and returns the `COMPRESSION_LEVEL` key from the input map parameter if it exists, or -1 if this key does not exist.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

COMPRESSION_LEVEL	back to summary
protected static final String COMPRESSION_LEVEL Compression-level for the archive file. Only values in [0-9] are allowed. Since 5.11

COMPRESSION_LEVEL

back to summary

protected static final String COMPRESSION_LEVEL

Compression-level for the archive file. Only values in [0-9] are allowed.

Since: 5.11

Constructor Detail

BaseFormat	back to summary
public BaseFormat()

Method Detail

applyFormatOptions	back to summary
protected ArchiveOutputStream<? extends ArchiveEntry> applyFormatOptions(ArchiveOutputStream<? extends ArchiveEntry> s, Map<String, Object> o) throws IOException Apply options to archive output stream Parameters s:ArchiveOutputStream<? extends ArchiveEntry> stream to apply options to o:Map<String, Object> options map Returns:ArchiveOutputStream<? extends ArchiveEntry> stream with option applied Exceptions IOException: if an IO error occurred

applyFormatOptions

back to summary

protected ArchiveOutputStream<? extends ArchiveEntry> applyFormatOptions(ArchiveOutputStream<? extends ArchiveEntry> s, Map<String, Object> o) throws IOException

Apply options to archive output stream

Parameters

s:ArchiveOutputStream<? extends ArchiveEntry>: stream to apply options to
o:Map<String, Object>: options map

Returns:ArchiveOutputStream<? extends ArchiveEntry>

stream with option applied

Exceptions

IOException:: if an IO error occurred

getCompressionLevel back to summary

getCompressionLevel	back to summary
protected int getCompressionLevel(Map<String, Object> o) Removes and returns the `COMPRESSION_LEVEL` key from the input map parameter if it exists, or -1 if this key does not exist. Parameters o:Map<String, Object> options map Returns:int The compression level if it exists in the map, or -1 instead. Exceptions IllegalArgumentException: if the `COMPRESSION_LEVEL` option does not parse to an Integer. Since 5.11

protected int getCompressionLevel(Map<String, Object> o)

Removes and returns the COMPRESSION_LEVEL key from the input map parameter if it exists, or -1 if this key does not exist.

Parameters

o:Map<String, Object>: options map

Returns:int

The compression level if it exists in the map, or -1 instead.

Exceptions

IllegalArgumentException:: if the COMPRESSION_LEVEL option does not parse to an Integer.

Since

5.11