equinox-core/com.tecknobit.equinoxcore.annotations

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Assembler(val structure: String = "")

The Assembler annotation is useful to indicate those methods used to assemble anything such payloads of the requests, queries of the requests, etc. For example

CustomParametersOrder

annotation class CustomParametersOrder(val order: String)

The CustomParametersOrder annotation is useful to manage the custom parameters order for a better readability of the code and to work with that parameters correctly

DTO

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class DTO

The DTO annotation is useful to indicate whether a class is used as Data Transfer Object

FutureEquinoxApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.TYPE_PARAMETER, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPE, AnnotationTarget.EXPRESSION, AnnotationTarget.FILE, AnnotationTarget.TYPEALIAS])

annotation class FutureEquinoxApi(val protoBehavior: String = "", val releaseVersion: String = "", val additionalNotes: String = "")

The FutureEquinoxApi annotation is useful to indicate an experimental api implemented in an external project outside Equinox that can be potentially implemented in the official library

RequestPath

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class RequestPath( val method: RequestMethod, val path: String = "", val pathParameters: String = "", val queryParameters: String = "", val bodyParameters: String = "")

Annotation that defines the request path and its parameters for API requests.

RequiresSuperCall

@Target(allowedTargets = [AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class RequiresSuperCall

The RequiresSuperCall annotation is useful to indicate that an inherited or an overridden method to works correctly and completely requires that also the original method is invoked like the @CallSuper annotation.

Returner

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Returner

The Returner annotation is used to mark methods that are responsible for formatting and returning data in a specified format

Structure

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Structure

The @Structure annotation is applied to classes that define a general structure and behavior for a potential hierarchy, along with its subclasses. It marks classes that provide a common template or foundation, often used for sharing general properties and functionality across a set of related classes.

Validator

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Validator(val validWhen: String = "")

The @Validator annotation is applied to those methods which are used to check the validity of an input, and it is useful to provide additional information about the annotated method such the validity case of the input checked

Wrapper

@Target(allowedTargets = [AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class Wrapper(val wrapperOf: String = "")

The @Wrapper annotation is applied to those wrapper methods that wrap the main method, facilitating access to the latter by avoiding the need to pass some unnecessary arguments.