system.threading

Class CancellationTokenSource

java.lang.Object

org.mases.jcobridge.netreflection.NetObject

system.threading.CancellationTokenSource

All Implemented Interfaces:

java.lang.AutoCloseable, IJCOBridgeReflected

public class CancellationTokenSource
extends NetObject
implements java.lang.AutoCloseable

The base .NET class managing System.Threading.CancellationTokenSource, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e.

.NET documentation at https://learn.microsoft.com/dotnet/api/System.Threading.CancellationTokenSource

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.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
static java.lang.String	assemblyShortName Assembly name: System.Private.CoreLib
static java.lang.String	className Qualified class name: System.Threading.CancellationTokenSource
static JCType	classType The type managed from JCOBridge.

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

Null

Constructor Summary

Constructors

Constructor and Description
CancellationTokenSource() Initializes a new instance by invoking the .NET constructor.
CancellationTokenSource(int millisecondsDelay) Initializes a new instance by invoking the .NET constructor.
CancellationTokenSource(java.lang.Object instance) Internal constructor.
CancellationTokenSource(TimeSpan delay) Initializes a new instance by invoking the .NET constructor.
CancellationTokenSource(TimeSpan delay, TimeProvider timeProvider) Initializes a new instance by invoking the .NET constructor.

Method Summary

Modifier and Type	Method and Description
void	Cancel() Invokes the .NET member Cancel.
void	Cancel(boolean throwOnFirstException) Invokes the .NET member Cancel.
void	CancelAfter(int millisecondsDelay) Invokes the .NET member CancelAfter.
void	CancelAfter(TimeSpan delay) Invokes the .NET member CancelAfter.
Task	CancelAsync() Invokes the .NET member CancelAsync.
static CancellationTokenSource	cast(IJCOBridgeReflected from) Try to cast the IJCOBridgeReflected instance into CancellationTokenSource, a cast assert is made to check if types are compatible.
void	close()
static CancellationTokenSource	CreateLinkedTokenSource(CancellationToken... tokens) Invokes the .NET member CreateLinkedTokenSource.
static CancellationTokenSource	CreateLinkedTokenSource(CancellationToken token) Invokes the .NET member CreateLinkedTokenSource.
static CancellationTokenSource	CreateLinkedTokenSource(CancellationToken token1, CancellationToken token2) Invokes the .NET member CreateLinkedTokenSource.
void	Dispose() Invokes the .NET member Dispose.
boolean	getIsCancellationRequested() Gets the value of the .NET property IsCancellationRequested.
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.
CancellationToken	getToken() Gets the value of the .NET property Token.
void	setJCOInstance(JCObject instance) Sets the underlying object managed by the bridge.
boolean	TryReset() Invokes the .NET member TryReset.

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.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e

See Also:

Constant Field Values

assemblyShortName

public static final java.lang.String assemblyShortName

Assembly name: System.Private.CoreLib

See Also:

Constant Field Values

className

public static final java.lang.String className

Qualified class name: System.Threading.CancellationTokenSource

See Also:

Constant Field Values

classType

public static JCType classType

The type managed from JCOBridge. See JCType

Constructor Detail

CancellationTokenSource

public CancellationTokenSource()
                        throws java.lang.Throwable

Initializes a new instance by invoking the .NET constructor.

Throws:

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

See Also:

.NET documentation

CancellationTokenSource

public CancellationTokenSource(int millisecondsDelay)
                        throws java.lang.Throwable,
                               ArgumentException,
                               ArgumentOutOfRangeException,
                               ArgumentNullException,
                               InvalidOperationException,
                               PlatformNotSupportedException,
                               ArrayTypeMismatchException,
                               NotSupportedException,
                               ObjectDisposedException,
                               RankException,
                               IndexOutOfRangeException,
                               OverflowException,
                               OutOfMemoryException

Initializes a new instance by invoking the .NET constructor.

Parameters:

millisecondsDelay - the argument of type int

Throws:

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

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

RankException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

OverflowException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

See Also:

.NET documentation

CancellationTokenSource

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

CancellationTokenSource

public CancellationTokenSource(TimeSpan delay)
                        throws java.lang.Throwable,
                               ArgumentException,
                               NotSupportedException,
                               InvalidOperationException,
                               ArgumentOutOfRangeException,
                               ArgumentNullException,
                               PlatformNotSupportedException,
                               OutOfMemoryException

Initializes a new instance by invoking the .NET constructor.

Parameters:

delay - the argument of type TimeSpan

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

PlatformNotSupportedException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

See Also:

.NET documentation

CancellationTokenSource

public CancellationTokenSource(TimeSpan delay,
                               TimeProvider timeProvider)
                        throws java.lang.Throwable,
                               ArgumentException,
                               ArgumentOutOfRangeException,
                               PlatformNotSupportedException,
                               NotSupportedException,
                               ObjectDisposedException,
                               InvalidOperationException,
                               RankException,
                               ArrayTypeMismatchException,
                               ArgumentNullException,
                               OutOfMemoryException

Initializes a new instance by invoking the .NET constructor.

Parameters:

delay - the argument of type TimeSpan

timeProvider - the argument of type TimeProvider

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

OutOfMemoryException - if the .NET member raises it

See Also:

.NET documentation

Method Detail

Cancel

public void Cancel()
            throws java.lang.Throwable,
                   ArgumentException,
                   NotSupportedException,
                   InvalidOperationException,
                   ArgumentOutOfRangeException,
                   ObjectDisposedException,
                   PlatformNotSupportedException,
                   ArgumentNullException,
                   IndexOutOfRangeException,
                   AggregateException

Invokes the .NET member Cancel.

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

PlatformNotSupportedException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

AggregateException - if the .NET member raises it

See Also:

.NET documentation

Cancel

public void Cancel(boolean throwOnFirstException)
            throws java.lang.Throwable,
                   ArgumentException,
                   ArgumentOutOfRangeException,
                   PlatformNotSupportedException,
                   NotSupportedException,
                   ObjectDisposedException,
                   InvalidOperationException,
                   RankException,
                   ArrayTypeMismatchException,
                   OutOfMemoryException,
                   ArgumentNullException,
                   AggregateException

Invokes the .NET member Cancel.

Parameters:

throwOnFirstException - the argument of type boolean

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

OutOfMemoryException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

AggregateException - if the .NET member raises it

See Also:

.NET documentation

CancelAfter

public void CancelAfter(int millisecondsDelay)
                 throws java.lang.Throwable,
                        ArgumentException,
                        ArgumentOutOfRangeException,
                        ArgumentNullException,
                        InvalidOperationException,
                        PlatformNotSupportedException,
                        ArrayTypeMismatchException,
                        NotSupportedException,
                        ObjectDisposedException,
                        RankException,
                        IndexOutOfRangeException,
                        EventSourceException,
                        OutOfMemoryException,
                        OverflowException

Invokes the .NET member CancelAfter.

Parameters:

millisecondsDelay - the argument of type int

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

ArgumentNullException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

RankException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

EventSourceException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

OverflowException - if the .NET member raises it

See Also:

.NET documentation

CancelAfter

public void CancelAfter(TimeSpan delay)
                 throws java.lang.Throwable,
                        ArgumentException,
                        ArgumentOutOfRangeException,
                        ArgumentNullException,
                        InvalidOperationException,
                        PlatformNotSupportedException,
                        ArrayTypeMismatchException,
                        NotSupportedException,
                        ObjectDisposedException,
                        RankException,
                        IndexOutOfRangeException,
                        EventSourceException,
                        OutOfMemoryException,
                        OverflowException

Invokes the .NET member CancelAfter.

Parameters:

delay - the argument of type TimeSpan

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

ArgumentNullException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

RankException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

EventSourceException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

OverflowException - if the .NET member raises it

See Also:

.NET documentation

CancelAsync

public Task CancelAsync()
                 throws java.lang.Throwable,
                        ArgumentException,
                        ArgumentOutOfRangeException,
                        ArgumentNullException,
                        InvalidOperationException,
                        PlatformNotSupportedException,
                        ArrayTypeMismatchException,
                        NotSupportedException,
                        IndexOutOfRangeException,
                        RankException,
                        CultureNotFoundException,
                        ObjectDisposedException,
                        AggregateException,
                        OutOfMemoryException,
                        TaskSchedulerException

Invokes the .NET member CancelAsync.

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

ArgumentNullException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

RankException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

AggregateException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

TaskSchedulerException - if the .NET member raises it

See Also:

.NET documentation

cast

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

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

Parameters:

from - IJCOBridgeReflected instance to be casted

Returns:

CancellationTokenSource 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

CreateLinkedTokenSource

public static CancellationTokenSource CreateLinkedTokenSource(CancellationToken... tokens)
                                                       throws java.lang.Throwable,
                                                              ArgumentException,
                                                              ArgumentOutOfRangeException,
                                                              PlatformNotSupportedException,
                                                              NotSupportedException,
                                                              ObjectDisposedException,
                                                              InvalidOperationException,
                                                              RankException,
                                                              ArrayTypeMismatchException,
                                                              ArgumentNullException

Invokes the .NET member CreateLinkedTokenSource.

Parameters:

tokens - 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

ArgumentNullException - if the .NET member raises it

See Also:

.NET documentation

CreateLinkedTokenSource

public static CancellationTokenSource CreateLinkedTokenSource(CancellationToken token)
                                                       throws java.lang.Throwable,
                                                              ArgumentNullException,
                                                              PlatformNotSupportedException

Invokes the .NET member CreateLinkedTokenSource.

Parameters:

token - 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

ArgumentNullException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

See Also:

.NET documentation

CreateLinkedTokenSource

public static CancellationTokenSource CreateLinkedTokenSource(CancellationToken token1,
                                                              CancellationToken token2)
                                                       throws java.lang.Throwable,
                                                              ArgumentNullException,
                                                              PlatformNotSupportedException

Invokes the .NET member CreateLinkedTokenSource.

Parameters:

token1 - the argument of type CancellationToken

token2 - 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

ArgumentNullException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

See Also:

.NET documentation

Dispose

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

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

ObjectDisposedException - if the .NET member raises it

See Also:

.NET documentation

getIsCancellationRequested

public boolean getIsCancellationRequested()
                                   throws java.lang.Throwable

Gets the value of the .NET property IsCancellationRequested.

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

getToken

public CancellationToken getToken()
                           throws java.lang.Throwable,
                                  ArgumentException,
                                  ArgumentOutOfRangeException,
                                  PlatformNotSupportedException,
                                  NotSupportedException,
                                  ObjectDisposedException,
                                  InvalidOperationException,
                                  RankException,
                                  ArrayTypeMismatchException

Gets the value of the .NET property Token.

Returns:

the value of the property

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

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

TryReset

public boolean TryReset()
                 throws java.lang.Throwable,
                        ArgumentException,
                        ArgumentOutOfRangeException,
                        PlatformNotSupportedException,
                        NotSupportedException,
                        ObjectDisposedException,
                        InvalidOperationException,
                        RankException,
                        ArrayTypeMismatchException,
                        EventSourceException,
                        AbandonedMutexException,
                        OutOfMemoryException

Invokes the .NET member TryReset.

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

EventSourceException - if the .NET member raises it

AbandonedMutexException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

See Also:

.NET documentation