system.formats.tar

Class TarWriter

java.lang.Object

org.mases.jcobridge.netreflection.NetObject

system.formats.tar.TarWriter

All Implemented Interfaces:

java.lang.AutoCloseable, IJCOBridgeReflected

public class TarWriter
extends NetObject
implements java.lang.AutoCloseable

The base .NET class managing System.Formats.Tar.TarWriter, System.Formats.Tar, Version=8.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51.

.NET documentation at https://learn.microsoft.com/dotnet/api/System.Formats.Tar.TarWriter

Powered by JCOBridge: more info at https://www.jcobridge.com

Author:

MASES s.r.l https://masesgroup.com

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	assemblyFullName Fully assembly qualified name: System.Formats.Tar, Version=8.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51
static java.lang.String	assemblyShortName Assembly name: System.Formats.Tar
static java.lang.String	className Qualified class name: System.Formats.Tar.TarWriter
static JCType	classType The type managed from JCOBridge.

Fields inherited from class org.mases.jcobridge.netreflection.NetObject

Null

Constructor Summary

Constructors

Constructor and Description
TarWriter()
TarWriter(java.lang.Object instance) Internal constructor.
TarWriter(Stream archiveStream) Initializes a new instance by invoking the .NET constructor.
TarWriter(Stream archiveStream, boolean leaveOpen) Initializes a new instance by invoking the .NET constructor.
TarWriter(Stream archiveStream, TarEntryFormat format, boolean leaveOpen) Initializes a new instance by invoking the .NET constructor.

Method Summary

Modifier and Type	Method and Description
static TarWriter	cast(IJCOBridgeReflected from) Try to cast the IJCOBridgeReflected instance into TarWriter, a cast assert is made to check if types are compatible.
void	close()
void	Dispose() Invokes the .NET member Dispose.
ValueTask	DisposeAsync() Invokes the .NET member DisposeAsync.
TarEntryFormat	getFormat() Gets the value of the .NET property Format.
java.lang.String	getJCOAssemblyName() Returns the full name of the assembly of the .NET type.
java.lang.String	getJCOClassName() Returns the full name of the .NET type.
java.lang.Object	getJCOInstance() Returns the underlying object managed by the bridge.
java.lang.String	getJCOObjectName() Returns the name of the .NET type qualified with its assembly.
JCType	getJCOType() Returns the JCType of the .NET type.
void	setFormat(TarEntryFormat Format) Sets the value of the .NET property Format.
void	setJCOInstance(JCObject instance) Sets the underlying object managed by the bridge.
void	WriteEntry(java.lang.String fileName, java.lang.String entryName) Invokes the .NET member WriteEntry.
void	WriteEntry(TarEntry entry) Invokes the .NET member WriteEntry.
Task	WriteEntryAsync(java.lang.String fileName, java.lang.String entryName, CancellationToken cancellationToken) Invokes the .NET member WriteEntryAsync.
Task	WriteEntryAsync(TarEntry entry, CancellationToken cancellationToken) Invokes the .NET member WriteEntryAsync.

Methods inherited from class org.mases.jcobridge.netreflection.NetObject

Equals, Equals, GetHashCode, GetType, hashCode, toString, ToString

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Field Detail

assemblyFullName

public static final java.lang.String assemblyFullName

Fully assembly qualified name: System.Formats.Tar, Version=8.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51

See Also:

Constant Field Values

assemblyShortName

public static final java.lang.String assemblyShortName

Assembly name: System.Formats.Tar

See Also:

Constant Field Values

className

public static final java.lang.String className

Qualified class name: System.Formats.Tar.TarWriter

See Also:

Constant Field Values

classType

public static JCType classType

The type managed from JCOBridge. See JCType

Constructor Detail

TarWriter

public TarWriter()
          throws java.lang.Throwable

Throws:

java.lang.Throwable

TarWriter

public TarWriter(java.lang.Object instance)
          throws java.lang.Throwable

Internal constructor. Use with caution

Parameters:

instance - the underlying bridge object: it must be a JCObject

Throws:

java.lang.Throwable - if instance is not a JCObject

TarWriter

public TarWriter(Stream archiveStream)
          throws java.lang.Throwable,
                 ArgumentException,
                 NotSupportedException,
                 InvalidOperationException,
                 ArgumentOutOfRangeException,
                 ArgumentNullException

Initializes a new instance by invoking the .NET constructor.

Parameters:

archiveStream - the argument of type Stream

Throws:

java.lang.Throwable - if the .NET constructor fails

ArgumentException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

See Also:

.NET documentation

TarWriter

public TarWriter(Stream archiveStream,
                 boolean leaveOpen)
          throws java.lang.Throwable,
                 ArgumentException,
                 NotSupportedException,
                 InvalidOperationException,
                 ArgumentOutOfRangeException,
                 ArgumentNullException

Initializes a new instance by invoking the .NET constructor.

Parameters:

archiveStream - the argument of type Stream

leaveOpen - the argument of type boolean

Throws:

java.lang.Throwable - if the .NET constructor fails

ArgumentException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

See Also:

.NET documentation

TarWriter

public TarWriter(Stream archiveStream,
                 TarEntryFormat format,
                 boolean leaveOpen)
          throws java.lang.Throwable,
                 ArgumentException,
                 ArgumentOutOfRangeException,
                 PlatformNotSupportedException,
                 NotSupportedException,
                 ObjectDisposedException,
                 InvalidOperationException,
                 RankException,
                 ArrayTypeMismatchException,
                 ArgumentNullException

Initializes a new instance by invoking the .NET constructor.

Parameters:

archiveStream - the argument of type Stream

format - the argument of type TarEntryFormat

leaveOpen - the argument of type boolean

Throws:

java.lang.Throwable - if the .NET constructor fails

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

See Also:

.NET documentation

Method Detail

cast

public static TarWriter cast(IJCOBridgeReflected from)
                      throws java.lang.Throwable

Try to cast the IJCOBridgeReflected instance into TarWriter, a cast assert is made to check if types are compatible.

Parameters:

from - IJCOBridgeReflected instance to be casted

Returns:

TarWriter instance

Throws:

java.lang.Throwable - in case of error during cast operation

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

Dispose

public void Dispose()
             throws java.lang.Throwable,
                    ArgumentException,
                    NotSupportedException,
                    InvalidOperationException,
                    ArgumentOutOfRangeException,
                    PlatformNotSupportedException,
                    ArrayTypeMismatchException

Invokes the .NET member Dispose.

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

See Also:

.NET documentation

DisposeAsync

public ValueTask DisposeAsync()
                       throws java.lang.Throwable,
                              ArgumentException,
                              NotSupportedException,
                              InvalidOperationException,
                              ArgumentOutOfRangeException,
                              ArgumentNullException

Invokes the .NET member DisposeAsync.

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

See Also:

.NET documentation

getFormat

public TarEntryFormat getFormat()
                         throws java.lang.Throwable

Gets the value of the .NET property Format.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

getJCOAssemblyName

public java.lang.String getJCOAssemblyName()

Description copied from class: NetObject

Returns the full name of the assembly of the .NET type.

Specified by:

getJCOAssemblyName in interface IJCOBridgeReflected

Overrides:

getJCOAssemblyName in class NetObject

Returns:

the full assembly name

getJCOClassName

public java.lang.String getJCOClassName()

Description copied from class: NetObject

Returns the full name of the .NET type.

Specified by:

getJCOClassName in interface IJCOBridgeReflected

Overrides:

getJCOClassName in class NetObject

Returns:

the full class name

getJCOInstance

public java.lang.Object getJCOInstance()

Description copied from class: NetObject

Returns the underlying object managed by the bridge.

Specified by:

getJCOInstance in interface IJCOBridgeReflected

Overrides:

getJCOInstance in class NetObject

Returns:

the underlying object, or null if there is none

getJCOObjectName

public java.lang.String getJCOObjectName()

Description copied from class: NetObject

Returns the name of the .NET type qualified with its assembly.

Specified by:

getJCOObjectName in interface IJCOBridgeReflected

Overrides:

getJCOObjectName in class NetObject

Returns:

the assembly qualified name

getJCOType

public JCType getJCOType()

Description copied from class: NetObject

Returns the JCType of the .NET type.

Specified by:

getJCOType in interface IJCOBridgeReflected

Overrides:

getJCOType in class NetObject

Returns:

the type of the .NET class

setFormat

public void setFormat(TarEntryFormat Format)
               throws java.lang.Throwable

Sets the value of the .NET property Format.

Parameters:

Format - the new value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

setJCOInstance

public void setJCOInstance(JCObject instance)

Description copied from class: NetObject

Sets the underlying object managed by the bridge.

Overrides:

setJCOInstance in class NetObject

Parameters:

instance - the new underlying object

WriteEntry

public void WriteEntry(java.lang.String fileName,
                       java.lang.String entryName)
                throws java.lang.Throwable,
                       ArgumentException,
                       NotSupportedException,
                       InvalidOperationException,
                       ArgumentOutOfRangeException,
                       ObjectDisposedException,
                       IndexOutOfRangeException,
                       PlatformNotSupportedException,
                       CultureNotFoundException,
                       FormatException,
                       IOException,
                       InvalidDataException,
                       DivideByZeroException,
                       ArgumentNullException,
                       ArrayTypeMismatchException,
                       SerializationException

Invokes the .NET member WriteEntry.

Parameters:

fileName - the argument of type java.lang.String

entryName - the argument of type java.lang.String

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

FormatException - if the .NET member raises it

IOException - if the .NET member raises it

InvalidDataException - if the .NET member raises it

DivideByZeroException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

SerializationException - if the .NET member raises it

See Also:

.NET documentation

WriteEntry

public void WriteEntry(TarEntry entry)
                throws java.lang.Throwable,
                       ArgumentException,
                       ArgumentOutOfRangeException,
                       PlatformNotSupportedException,
                       NotSupportedException,
                       ObjectDisposedException,
                       InvalidOperationException,
                       RankException,
                       ArrayTypeMismatchException,
                       IOException,
                       IndexOutOfRangeException,
                       FormatException,
                       DivideByZeroException,
                       OverflowException,
                       InvalidDataException

Invokes the .NET member WriteEntry.

Parameters:

entry - the argument of type TarEntry

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

IOException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

FormatException - if the .NET member raises it

DivideByZeroException - if the .NET member raises it

OverflowException - if the .NET member raises it

InvalidDataException - if the .NET member raises it

See Also:

.NET documentation

WriteEntryAsync

public Task WriteEntryAsync(java.lang.String fileName,
                            java.lang.String entryName,
                            CancellationToken cancellationToken)
                     throws java.lang.Throwable,
                            ArgumentException,
                            ArgumentOutOfRangeException,
                            PlatformNotSupportedException,
                            NotSupportedException,
                            ObjectDisposedException,
                            InvalidOperationException,
                            RankException,
                            ArrayTypeMismatchException,
                            IndexOutOfRangeException,
                            CultureNotFoundException

Invokes the .NET member WriteEntryAsync.

Parameters:

fileName - the argument of type java.lang.String

entryName - the argument of type java.lang.String

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

See Also:

.NET documentation

WriteEntryAsync

public Task WriteEntryAsync(TarEntry entry,
                            CancellationToken cancellationToken)
                     throws java.lang.Throwable,
                            ArgumentException,
                            ArgumentOutOfRangeException,
                            PlatformNotSupportedException,
                            NotSupportedException,
                            ObjectDisposedException,
                            InvalidOperationException,
                            RankException,
                            ArrayTypeMismatchException,
                            IOException

Invokes the .NET member WriteEntryAsync.

Parameters:

entry - the argument of type TarEntry

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

IOException - if the .NET member raises it

See Also:

.NET documentation