@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/types/java/lang/reflect/Constructor/index.d.ts

@@ -0,0 +1,236 @@
+import type { Class } from "../../Class";
+import type { String } from "../../String";
+
+import type { TypeVariable } from "../TypeVariable";
+import type { Type } from "../Type";
+import type { Object } from "../../Object";
+
+import type { Annotation } from "../../annotation/Annotation";
+import type { AnnotatedType } from "../AnnotatedType";
+import type { Executable } from "../Executable";
+
+/**
+ * {@code Constructor} provides information about, and access to, a single
+ *  constructor for a class.
+ *
+ *  <p>{@code Constructor} permits widening conversions to occur when matching the
+ *  actual parameters to newInstance() with the underlying
+ *  constructor's formal parameters, but throws an
+ *  {@code IllegalArgumentException} if a narrowing conversion would occur.
+ * @param <T> the class in which the constructor is declared
+ * @see Member
+ * @see java.lang.Class
+ * @see java.lang.Class#getConstructors()
+ * @see java.lang.Class#getConstructor(Class[])
+ * @see java.lang.Class#getDeclaredConstructors()
+ * @author Kenneth Russell
+ * @author Nakul Saraiya
+ */
+export type Constructor = Executable & {
+  /**
+ * {@inheritDoc}
+  
+    */
+  getDeclaringClass(): Class;
+
+  /**
+ * Returns the name of this constructor, as a string.  This is
+ *  the binary name of the constructor's declaring class.
+  
+    */
+  getName(): string;
+
+  /**
+ * {@inheritDoc}
+  
+    */
+  getModifiers(): number;
+
+  /**
+   * {@inheritDoc}
+   * @throws GenericSignatureFormatError {@inheritDoc}
+   * @since 1.5
+   */
+  getTypeParameters(): TypeVariable;
+
+  /**
+ * {@inheritDoc}
+  
+    */
+  getParameterTypes(): Class;
+
+  /**
+   * {@inheritDoc}
+   * @since 1.8
+   */
+  getParameterCount(): number;
+
+  /**
+   * {@inheritDoc}
+   * @throws GenericSignatureFormatError {@inheritDoc}
+   * @throws TypeNotPresentException {@inheritDoc}
+   * @throws MalformedParameterizedTypeException {@inheritDoc}
+   * @since 1.5
+   */
+  getGenericParameterTypes(): Type;
+
+  /**
+ * {@inheritDoc}
+  
+    */
+  getExceptionTypes(): Class;
+
+  /**
+   * {@inheritDoc}
+   * @throws GenericSignatureFormatError {@inheritDoc}
+   * @throws TypeNotPresentException {@inheritDoc}
+   * @throws MalformedParameterizedTypeException {@inheritDoc}
+   * @since 1.5
+   */
+  getGenericExceptionTypes(): Type;
+
+  /**
+ * Compares this {@code Constructor} against the specified object.
+ *  Returns true if the objects are the same.  Two {@code Constructor} objects are
+ *  the same if they were declared by the same class and have the
+ *  same formal parameter types.
+  
+    */
+  equals(obj: unknown): boolean;
+
+  /**
+ * Returns a hashcode for this {@code Constructor}. The hashcode is
+ *  the same as the hashcode for the underlying constructor's
+ *  declaring class name.
+  
+    */
+  hashCode(): number;
+
+  /**
+   * Returns a string describing this {@code Constructor}.  The string is
+   *  formatted as the constructor access modifiers, if any,
+   *  followed by the fully-qualified name of the declaring class,
+   *  followed by a parenthesized, comma-separated list of the
+   *  constructor's formal parameter types.  For example:
+   *  <pre>
+   *     public java.util.Hashtable(int,float)
+   *  </pre>
+   *
+   *  <p>The only possible modifiers for constructors are the access
+   *  modifiers {@code public}, {@code protected} or
+   *  {@code private}.  Only one of these may appear, or none if the
+   *  constructor has default (package) access.
+   * @return a string describing this {@code Constructor}
+   * @jls 8.8.3. Constructor Modifiers
+   */
+  toString(): string;
+
+  /**
+   * Returns a string describing this {@code Constructor},
+   *  including type parameters.  The string is formatted as the
+   *  constructor access modifiers, if any, followed by an
+   *  angle-bracketed comma separated list of the constructor's type
+   *  parameters, if any, followed by the fully-qualified name of the
+   *  declaring class, followed by a parenthesized, comma-separated
+   *  list of the constructor's generic formal parameter types.
+   *
+   *  If this constructor was declared to take a variable number of
+   *  arguments, instead of denoting the last parameter as
+   *  "<tt><i>Type</i>[]</tt>", it is denoted as
+   *  "<tt><i>Type</i>...</tt>".
+   *
+   *  A space is used to separate access modifiers from one another
+   *  and from the type parameters or return type.  If there are no
+   *  type parameters, the type parameter list is elided; if the type
+   *  parameter list is present, a space separates the list from the
+   *  class name.  If the constructor is declared to throw
+   *  exceptions, the parameter list is followed by a space, followed
+   *  by the word "{@code throws}" followed by a
+   *  comma-separated list of the thrown exception types.
+   *
+   *  <p>The only possible modifiers for constructors are the access
+   *  modifiers {@code public}, {@code protected} or
+   *  {@code private}.  Only one of these may appear, or none if the
+   *  constructor has default (package) access.
+   * @return a string describing this {@code Constructor},&#xA; include type parameters
+   * @since 1.5
+   * @jls 8.8.3. Constructor Modifiers
+   */
+  toGenericString(): string;
+
+  /**
+   * Uses the constructor represented by this {@code Constructor} object to
+   *  create and initialize a new instance of the constructor's
+   *  declaring class, with the specified initialization parameters.
+   *  Individual parameters are automatically unwrapped to match
+   *  primitive formal parameters, and both primitive and reference
+   *  parameters are subject to method invocation conversions as necessary.
+   *
+   *  <p>If the number of formal parameters required by the underlying constructor
+   *  is 0, the supplied {@code initargs} array may be of length 0 or null.
+   *
+   *  <p>If the constructor's declaring class is an inner class in a
+   *  non-static context, the first argument to the constructor needs
+   *  to be the enclosing instance; see section 15.9.3 of
+   *  <cite>The Java&trade; Language Specification</cite>.
+   *
+   *  <p>If the required access and argument checks succeed and the
+   *  instantiation will proceed, the constructor's declaring class
+   *  is initialized if it has not already been initialized.
+   *
+   *  <p>If the constructor completes normally, returns the newly
+   *  created and initialized instance.
+   * @param initargs array of objects to be passed as arguments to&#xA; the constructor call; values of primitive types are wrapped in&#xA; a wrapper object of the appropriate type (e.g. a {@code float}&#xA; in a {@link java.lang.Float Float})
+   * @return a new object created by calling the constructor&#xA; this object represents
+   * @throws IllegalAccessException if this {@code Constructor} object&#xA; is enforcing Java language access control and the underlying&#xA; constructor is inaccessible.
+   * @throws IllegalArgumentException if the number of actual&#xA; and formal parameters differ; if an unwrapping&#xA; conversion for primitive arguments fails; or if,&#xA; after possible unwrapping, a parameter value&#xA; cannot be converted to the corresponding formal&#xA; parameter type by a method invocation conversion; if&#xA; this constructor pertains to an enum type.
+   * @throws InstantiationException if the class that declares the&#xA; underlying constructor represents an abstract class.
+   * @throws InvocationTargetException if the underlying constructor&#xA; throws an exception.
+   * @throws ExceptionInInitializerError if the initialization provoked&#xA; by this method fails.
+   */
+  newInstance(initargs: unknown[]): unknown;
+
+  /**
+   * {@inheritDoc}
+   * @since 1.5
+   */
+  isVarArgs(): boolean;
+
+  /**
+   * {@inheritDoc}
+   * @jls 13.1 The Form of a Binary
+   * @since 1.5
+   */
+  isSynthetic(): boolean;
+
+  /**
+   * {@inheritDoc}
+   * @throws NullPointerException {@inheritDoc}
+   * @since 1.5
+   */
+  getAnnotation(annotationClass: Class): unknown;
+
+  /**
+   * {@inheritDoc}
+   * @since 1.5
+   */
+  getDeclaredAnnotations(): Annotation;
+
+  /**
+   * {@inheritDoc}
+   * @since 1.5
+   */
+  getParameterAnnotations(): Annotation;
+
+  /**
+   * {@inheritDoc}
+   * @since 1.8
+   */
+  getAnnotatedReturnType(): AnnotatedType;
+
+  /**
+   * {@inheritDoc}
+   * @since 1.8
+   */
+  getAnnotatedReceiverType(): AnnotatedType;
+};

package/types/java/lang/reflect/Constructor/index.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getDeclaringClass: function getDeclaringClass() {},
+  getName: function getName() {},
+  getModifiers: function getModifiers() {},
+  getTypeParameters: function getTypeParameters() {},
+  getParameterTypes: function getParameterTypes() {},
+  getParameterCount: function getParameterCount() {},
+  getGenericParameterTypes: function getGenericParameterTypes() {},
+  getExceptionTypes: function getExceptionTypes() {},
+  getGenericExceptionTypes: function getGenericExceptionTypes() {},
+  equals: function equals() {},
+  hashCode: function hashCode() {},
+  toString: function toString() {},
+  toGenericString: function toGenericString() {},
+  newInstance: function newInstance() {},
+  isVarArgs: function isVarArgs() {},
+  isSynthetic: function isSynthetic() {},
+  getAnnotation: function getAnnotation() {},
+  getDeclaredAnnotations: function getDeclaredAnnotations() {},
+  getParameterAnnotations: function getParameterAnnotations() {},
+  getAnnotatedReturnType: function getAnnotatedReturnType() {},
+  getAnnotatedReceiverType: function getAnnotatedReceiverType() {}
+};
+exports["default"] = _default;

package/types/java/lang/reflect/Executable/index.d.ts

@@ -0,0 +1,255 @@
+import type { Class } from "../../Class";
+import type { String } from "../../String";
+
+import type { TypeVariable } from "../TypeVariable";
+import type { Type } from "../Type";
+import type { Parameter } from "../Parameter";
+
+import type { Annotation } from "../../annotation/Annotation";
+
+import type { AnnotatedType } from "../AnnotatedType";
+import type { AccessibleObject } from "../AccessibleObject";
+import type { Member } from "../Member";
+import type { GenericDeclaration } from "../GenericDeclaration";
+
+/**
+ * A shared superclass for the common functionality of {@link Method}
+ *  and {@link Constructor}.
+ * @since 1.8
+ */
+export type Executable = AccessibleObject &
+  Member &
+  GenericDeclaration & {
+    /**
+ * Returns the {@code Class} object representing the class or interface
+ *  that declares the executable represented by this object.
+  
+    */
+    getDeclaringClass(): Class;
+
+    /**
+ * Returns the name of the executable represented by this object.
+  
+    */
+    getName(): string;
+
+    /**
+ * Returns the Java language {@linkplain Modifier modifiers} for
+ *  the executable represented by this object.
+  
+    */
+    getModifiers(): number;
+
+    /**
+     * Returns an array of {@code TypeVariable} objects that represent the
+     *  type variables declared by the generic declaration represented by this
+     *  {@code GenericDeclaration} object, in declaration order.  Returns an
+     *  array of length 0 if the underlying generic declaration declares no type
+     *  variables.
+     * @return an array of {@code TypeVariable} objects that represent
 the type variables declared by this generic declaration
+     * @throws GenericSignatureFormatError if the generic&#xA; signature of this generic declaration does not conform to&#xA; the format specified in&#xA; <cite>The Java&trade; Virtual Machine Specification</cite>
+     */
+    getTypeParameters(): TypeVariable;
+
+    /**
+     * Returns an array of {@code Class} objects that represent the formal
+     *  parameter types, in declaration order, of the executable
+     *  represented by this object.  Returns an array of length
+     *  0 if the underlying executable takes no parameters.
+     * @return the parameter types for the executable this object&#xA; represents
+     */
+    getParameterTypes(): Class;
+
+    /**
+     * Returns the number of formal parameters (whether explicitly
+     *  declared or implicitly declared or neither) for the executable
+     *  represented by this object.
+     * @return The number of formal parameters for the executable this&#xA; object represents
+     */
+    getParameterCount(): number;
+
+    /**
+     * Returns an array of {@code Type} objects that represent the formal
+     *  parameter types, in declaration order, of the executable represented by
+     *  this object. Returns an array of length 0 if the
+     *  underlying executable takes no parameters.
+     *
+     *  <p>If a formal parameter type is a parameterized type,
+     *  the {@code Type} object returned for it must accurately reflect
+     *  the actual type parameters used in the source code.
+     *
+     *  <p>If a formal parameter type is a type variable or a parameterized
+     *  type, it is created. Otherwise, it is resolved.
+     * @return an array of {@code Type}s that represent the formal&#xA; parameter types of the underlying executable, in declaration order
+     * @throws GenericSignatureFormatError&#xA; if the generic method signature does not conform to the format&#xA; specified in&#xA; <cite>The Java&trade; Virtual Machine Specification</cite>
+     * @throws TypeNotPresentException if any of the parameter&#xA; types of the underlying executable refers to a non-existent type&#xA; declaration
+     * @throws MalformedParameterizedTypeException if any of&#xA; the underlying executable's parameter types refer to a parameterized&#xA; type that cannot be instantiated for any reason
+     */
+    getGenericParameterTypes(): Type;
+
+    /**
+     * Returns an array of {@code Parameter} objects that represent
+     *  all the parameters to the underlying executable represented by
+     *  this object.  Returns an array of length 0 if the executable
+     *  has no parameters.
+     *
+     *  <p>The parameters of the underlying executable do not necessarily
+     *  have unique names, or names that are legal identifiers in the
+     *  Java programming language (JLS 3.8).
+     * @throws MalformedParametersException if the class file contains&#xA; a MethodParameters attribute that is improperly formatted.
+     * @return an array of {@code Parameter} objects representing all&#xA; the parameters to the executable this object represents.
+     */
+    getParameters(): Parameter;
+
+    /**
+     * Returns an array of {@code Class} objects that represent the
+     *  types of exceptions declared to be thrown by the underlying
+     *  executable represented by this object.  Returns an array of
+     *  length 0 if the executable declares no exceptions in its {@code
+     *  throws} clause.
+     * @return the exception types declared as being thrown by the&#xA; executable this object represents
+     */
+    getExceptionTypes(): Class;
+
+    /**
+     * Returns an array of {@code Type} objects that represent the
+     *  exceptions declared to be thrown by this executable object.
+     *  Returns an array of length 0 if the underlying executable declares
+     *  no exceptions in its {@code throws} clause.
+     *
+     *  <p>If an exception type is a type variable or a parameterized
+     *  type, it is created. Otherwise, it is resolved.
+     * @return an array of Types that represent the exception types&#xA; thrown by the underlying executable
+     * @throws GenericSignatureFormatError&#xA; if the generic method signature does not conform to the format&#xA; specified in&#xA; <cite>The Java&trade; Virtual Machine Specification</cite>
+     * @throws TypeNotPresentException if the underlying executable's&#xA; {@code throws} clause refers to a non-existent type declaration
+     * @throws MalformedParameterizedTypeException if&#xA; the underlying executable's {@code throws} clause refers to a&#xA; parameterized type that cannot be instantiated for any reason
+     */
+    getGenericExceptionTypes(): Type;
+
+    /**
+     * Returns a string describing this {@code Executable}, including
+     *  any type parameters.
+     * @return a string describing this {@code Executable}, including&#xA; any type parameters
+     */
+    toGenericString(): string;
+
+    /**
+     * Returns {@code true} if this executable was declared to take a
+     *  variable number of arguments; returns {@code false} otherwise.
+     * @return {@code true} if an only if this executable was declared&#xA; to take a variable number of arguments.
+     */
+    isVarArgs(): boolean;
+
+    /**
+     * Returns {@code true} if this executable is a synthetic
+     *  construct; returns {@code false} otherwise.
+     * @return true if and only if this executable is a synthetic&#xA; construct as defined by&#xA; <cite>The Java&trade; Language Specification</cite>.
+     * @jls 13.1 The Form of a Binary
+     */
+    isSynthetic(): boolean;
+
+    /**
+     * Returns an array of arrays of {@code Annotation}s that
+     *  represent the annotations on the formal parameters, in
+     *  declaration order, of the {@code Executable} represented by
+     *  this object.  Synthetic and mandated parameters (see
+     *  explanation below), such as the outer "this" parameter to an
+     *  inner class constructor will be represented in the returned
+     *  array.  If the executable has no parameters (meaning no formal,
+     *  no synthetic, and no mandated parameters), a zero-length array
+     *  will be returned.  If the {@code Executable} has one or more
+     *  parameters, a nested array of length zero is returned for each
+     *  parameter with no annotations. The annotation objects contained
+     *  in the returned arrays are serializable.  The caller of this
+     *  method is free to modify the returned arrays; it will have no
+     *  effect on the arrays returned to other callers.
+     *
+     *  A compiler may add extra parameters that are implicitly
+     *  declared in source ("mandated"), as well as parameters that
+     *  are neither implicitly nor explicitly declared in source
+     *  ("synthetic") to the parameter list for a method.  See {@link
+     *  java.lang.reflect.Parameter} for more information.
+     * @see java.lang.reflect.Parameter
+     * @see java.lang.reflect.Parameter#getAnnotations
+     * @return an array of arrays that represent the annotations on&#xA; the formal and implicit parameters, in declaration order, of&#xA; the executable represented by this object
+     */
+    getParameterAnnotations(): Annotation;
+
+    /**
+     * {@inheritDoc}
+     * @throws NullPointerException {@inheritDoc}
+     */
+    getAnnotation(annotationClass: Class): unknown;
+
+    /**
+     * {@inheritDoc}
+     * @throws NullPointerException {@inheritDoc}
+     */
+    getAnnotationsByType(annotationClass: Class): unknown;
+
+    /**
+ * {@inheritDoc}
+  
+    */
+    getDeclaredAnnotations(): Annotation;
+
+    /**
+     * Returns an {@code AnnotatedType} object that represents the use of a type to
+     *  specify the return type of the method/constructor represented by this
+     *  Executable.
+     *
+     *  If this {@code Executable} object represents a constructor, the {@code
+     *  AnnotatedType} object represents the type of the constructed object.
+     *
+     *  If this {@code Executable} object represents a method, the {@code
+     *  AnnotatedType} object represents the use of a type to specify the return
+     *  type of the method.
+     * @return an object representing the return type of the method&#xA; or constructor represented by this {@code Executable}
+     */
+    getAnnotatedReturnType(): AnnotatedType;
+
+    /**
+     * Returns an {@code AnnotatedType} object that represents the use of a
+     *  type to specify the receiver type of the method/constructor represented
+     *  by this Executable object. The receiver type of a method/constructor is
+     *  available only if the method/constructor has a <em>receiver
+     *  parameter</em> (JLS 8.4.1).
+     *
+     *  If this {@code Executable} object represents a constructor or instance
+     *  method that does not have a receiver parameter, or has a receiver
+     *  parameter with no annotations on its type, then the return value is an
+     *  {@code AnnotatedType} object representing an element with no
+     *  annotations.
+     *
+     *  If this {@code Executable} object represents a static method, then the
+     *  return value is null.
+     * @return an object representing the receiver type of the method or&#xA; constructor represented by this {@code Executable}
+     */
+    getAnnotatedReceiverType(): AnnotatedType;
+
+    /**
+     * Returns an array of {@code AnnotatedType} objects that represent the use
+     *  of types to specify formal parameter types of the method/constructor
+     *  represented by this Executable. The order of the objects in the array
+     *  corresponds to the order of the formal parameter types in the
+     *  declaration of the method/constructor.
+     *
+     *  Returns an array of length 0 if the method/constructor declares no
+     *  parameters.
+     * @return an array of objects representing the types of the&#xA; formal parameters of the method or constructor represented by this&#xA; {@code Executable}
+     */
+    getAnnotatedParameterTypes(): AnnotatedType;
+
+    /**
+     * Returns an array of {@code AnnotatedType} objects that represent the use
+     *  of types to specify the declared exceptions of the method/constructor
+     *  represented by this Executable. The order of the objects in the array
+     *  corresponds to the order of the exception types in the declaration of
+     *  the method/constructor.
+     *
+     *  Returns an array of length 0 if the method/constructor declares no
+     *  exceptions.
+     * @return an array of objects representing the declared&#xA; exceptions of the method or constructor represented by this {@code&#xA; Executable}
+     */
+    getAnnotatedExceptionTypes(): AnnotatedType;
+  };

package/types/java/lang/reflect/Executable/index.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getDeclaringClass: function getDeclaringClass() {},
+  getName: function getName() {},
+  getModifiers: function getModifiers() {},
+  getTypeParameters: function getTypeParameters() {},
+  getParameterTypes: function getParameterTypes() {},
+  getParameterCount: function getParameterCount() {},
+  getGenericParameterTypes: function getGenericParameterTypes() {},
+  getParameters: function getParameters() {},
+  getExceptionTypes: function getExceptionTypes() {},
+  getGenericExceptionTypes: function getGenericExceptionTypes() {},
+  toGenericString: function toGenericString() {},
+  isVarArgs: function isVarArgs() {},
+  isSynthetic: function isSynthetic() {},
+  getParameterAnnotations: function getParameterAnnotations() {},
+  getAnnotation: function getAnnotation() {},
+  getAnnotationsByType: function getAnnotationsByType() {},
+  getDeclaredAnnotations: function getDeclaredAnnotations() {},
+  getAnnotatedReturnType: function getAnnotatedReturnType() {},
+  getAnnotatedReceiverType: function getAnnotatedReceiverType() {},
+  getAnnotatedParameterTypes: function getAnnotatedParameterTypes() {},
+  getAnnotatedExceptionTypes: function getAnnotatedExceptionTypes() {}
+};
+exports["default"] = _default;