io.sarl.sarlspecification

Interface SarlSpecificationChecker

All Known Implementing Classes:

StandardSarlSpecificationChecker

public interface SarlSpecificationChecker

Check if a given agent class follows a specific version of the SARL specifications.

Since:

0.5

Version:

io.sarl.util 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.sarl

Maven Artifact Id:

io.sarl.util

Method Summary

Modifier and Type	Method and Description
default int	compareToSarlSpecificationVersion(type : Class<?>) Compare the SARL specification version associated to the given type to the version of the current SARL.
default float	getSarlSpecificationVersion(type : Class<?>) Deprecated. since 0.10, see #getSarlSpecificationVersionObject(Class)
default org.osgi.framework.Version	getSarlSpecificationVersionObject(type : Class<?>) Replies the supported SARL specification version of the given type.
default boolean	isValidSarlElement(type : Class<?>) Replies if the given type is a SARL element that is following the specification of the current SARL version.

Method Detail

getSarlSpecificationVersion

@Deprecated
 @Pure
default def getSarlSpecificationVersion(type : Class<?>) : float 

Deprecated. since 0.10, see #getSarlSpecificationVersionObject(Class)

Description copied from interface: SarlSpecificationChecker

Replies the supported SARL specification version of the given type.

Parameters:

type - the type from which the SARL specification version should be extracted.

Returns:

The SARL specification version. The version is a floating-point number, as for SARLVersion#SPECIFICATION_RELEASE_VERSION. The value Float.NaN is replied if the given type has no marker related to the SARL specification version.

getSarlSpecificationVersionObject

@Pure
default def getSarlSpecificationVersionObject(type : Class<?>) : org.osgi.framework.Version 

Description copied from interface: SarlSpecificationChecker

Replies the supported SARL specification version of the given type.

Parameters:

type - the type from which the SARL specification version should be extracted.

Returns:

The SARL specification version. The version is a Version, as for SARLVersion.SPECIFICATION_RELEASE_VERSION_STRING. The value null is replied if the given type has no marker related to the SARL specification version.

Since:

0.10

compareToSarlSpecificationVersion

default def compareToSarlSpecificationVersion(type : Class<?>) : int 

Description copied from interface: SarlSpecificationChecker

Compare the SARL specification version associated to the given type to the version of the current SARL.

Parameters:

type - the type to test.

Returns:

a negative integer value if the type's version is lower than the version of the current SARL, zero if the two versions are equal, a positive integer value if type's version is greater than the version of the current SARL.

isValidSarlElement

@Pure
default def isValidSarlElement(type : Class<?>) : boolean 

Description copied from interface: SarlSpecificationChecker

Replies if the given type is a SARL element that is following the specification of the current SARL version.

Parameters:

type - the type to test.

Returns:

true if the given type follows the specification of the current version.