system.io.pipelines

Class PipeWriter

java.lang.Object

org.mases.jcobridge.netreflection.NetObject

system.io.pipelines.PipeWriter

All Implemented Interfaces:

IJCOBridgeReflected

public class PipeWriter
extends NetObject

The base .NET class managing System.IO.Pipelines.PipeWriter, System.IO.Pipelines, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51.

.NET documentation at https://learn.microsoft.com/dotnet/api/System.IO.Pipelines.PipeWriter

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.IO.Pipelines, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51
static java.lang.String	assemblyShortName Assembly name: System.IO.Pipelines
static java.lang.String	className Qualified class name: System.IO.Pipelines.PipeWriter
static JCType	classType The type managed from JCOBridge.

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

Null

Constructor Summary

Constructors

Constructor and Description
PipeWriter()
PipeWriter(java.lang.Object instance) Internal constructor.

Method Summary

Modifier and Type	Method and Description
void	Advance(int bytes) Invokes the .NET member Advance.
Stream	AsStream(boolean leaveOpen) Invokes the .NET member AsStream.
void	CancelPendingFlush() Invokes the .NET member CancelPendingFlush.
static PipeWriter	cast(IJCOBridgeReflected from) Try to cast the IJCOBridgeReflected instance into PipeWriter, a cast assert is made to check if types are compatible.
void	Complete(NetException exception) Invokes the .NET member Complete.
ValueTask	CompleteAsync(NetException exception) Invokes the .NET member CompleteAsync.
static PipeWriter	Create(Stream stream, StreamPipeWriterOptions writerOptions) Invokes the .NET member Create.
ValueTask_1	FlushAsync(CancellationToken cancellationToken) Invokes the .NET member FlushAsync.
boolean	getCanGetUnflushedBytes() Gets the value of the .NET property CanGetUnflushedBytes.
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.
Memory_1	GetMemory(int sizeHint) Invokes the .NET member GetMemory.
long	getUnflushedBytes() Gets the value of the .NET property UnflushedBytes.
void	OnReaderCompleted(Action_2 callback, NetObject state) Invokes the .NET member OnReaderCompleted.
void	setJCOInstance(JCObject instance) Sets the underlying object managed by the bridge.
ValueTask_1	WriteAsync(ReadOnlyMemory_1 source, CancellationToken cancellationToken) Invokes the .NET member WriteAsync.

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.IO.Pipelines, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51

See Also:

Constant Field Values

assemblyShortName

public static final java.lang.String assemblyShortName

Assembly name: System.IO.Pipelines

See Also:

Constant Field Values

className

public static final java.lang.String className

Qualified class name: System.IO.Pipelines.PipeWriter

See Also:

Constant Field Values

classType

public static JCType classType

The type managed from JCOBridge. See JCType

Constructor Detail

PipeWriter

public PipeWriter()
           throws java.lang.Throwable

Throws:

java.lang.Throwable

PipeWriter

public PipeWriter(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

Method Detail

Advance

public void Advance(int bytes)
             throws java.lang.Throwable

Invokes the .NET member Advance.

Parameters:

bytes - the argument of type int

Throws:

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

See Also:

.NET documentation

AsStream

public Stream AsStream(boolean leaveOpen)
                throws java.lang.Throwable

Invokes the .NET member AsStream.

Parameters:

leaveOpen - the argument of type boolean

Returns:

the value returned by the .NET member

Throws:

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

See Also:

.NET documentation

CancelPendingFlush

public void CancelPendingFlush()
                        throws java.lang.Throwable

Invokes the .NET member CancelPendingFlush.

Throws:

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

See Also:

.NET documentation

cast

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

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

Parameters:

from - IJCOBridgeReflected instance to be casted

Returns:

PipeWriter instance

Throws:

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

Complete

public void Complete(NetException exception)
              throws java.lang.Throwable

Invokes the .NET member Complete.

Parameters:

exception - the argument of type NetException

Throws:

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

See Also:

.NET documentation

CompleteAsync

public ValueTask CompleteAsync(NetException exception)
                        throws java.lang.Throwable,
                               ArgumentException,
                               ArgumentOutOfRangeException,
                               PlatformNotSupportedException,
                               NotSupportedException,
                               ObjectDisposedException,
                               InvalidOperationException,
                               ArgumentNullException,
                               NullReferenceException,
                               IndexOutOfRangeException

Invokes the .NET member CompleteAsync.

Parameters:

exception - the argument of type NetException

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

ArgumentNullException - if the .NET member raises it

NullReferenceException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

See Also:

.NET documentation

Create

public static PipeWriter Create(Stream stream,
                                StreamPipeWriterOptions writerOptions)
                         throws java.lang.Throwable,
                                PlatformNotSupportedException,
                                ArgumentException,
                                NotSupportedException,
                                InvalidOperationException,
                                ArgumentOutOfRangeException,
                                ArgumentNullException

Invokes the .NET member Create.

Parameters:

stream - the argument of type Stream

writerOptions - the argument of type StreamPipeWriterOptions

Returns:

the value returned by the .NET member

Throws:

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

PlatformNotSupportedException - if the .NET member raises it

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

FlushAsync

public ValueTask_1 FlushAsync(CancellationToken cancellationToken)
                       throws java.lang.Throwable

Invokes the .NET member FlushAsync.

Parameters:

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

See Also:

.NET documentation

getCanGetUnflushedBytes

public boolean getCanGetUnflushedBytes()
                                throws java.lang.Throwable

Gets the value of the .NET property CanGetUnflushedBytes.

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

GetMemory

public Memory_1 GetMemory(int sizeHint)
                   throws java.lang.Throwable

Invokes the .NET member GetMemory.

Parameters:

sizeHint - the argument of type int

Returns:

the value returned by the .NET member

Throws:

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

See Also:

.NET documentation

getUnflushedBytes

public long getUnflushedBytes()
                       throws java.lang.Throwable,
                              ArgumentNullException,
                              ArgumentException,
                              PlatformNotSupportedException,
                              NotSupportedException,
                              ArgumentOutOfRangeException,
                              CultureNotFoundException,
                              InvalidOperationException,
                              ObjectDisposedException

Gets the value of the .NET property UnflushedBytes.

Returns:

the value of the property

Throws:

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

ArgumentNullException - if the .NET member raises it

ArgumentException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

See Also:

.NET documentation

OnReaderCompleted

public void OnReaderCompleted(Action_2 callback,
                              NetObject state)
                       throws java.lang.Throwable

Invokes the .NET member OnReaderCompleted.

Parameters:

callback - the argument of type Action_2

state - the argument of type NetObject

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

WriteAsync

public ValueTask_1 WriteAsync(ReadOnlyMemory_1 source,
                              CancellationToken cancellationToken)
                       throws java.lang.Throwable,
                              PlatformNotSupportedException,
                              ArgumentOutOfRangeException,
                              ArgumentException

Invokes the .NET member WriteAsync.

Parameters:

source - the argument of type ReadOnlyMemory_1

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

PlatformNotSupportedException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentException - if the .NET member raises it

See Also:

.NET documentation