Module java4ever.binding

Package tech.deplant.java4ever.binding.generator.jtype

Record Class SdkParam

java.lang.Object

java.lang.Record

tech.deplant.java4ever.binding.generator.jtype.SdkParam

public record SdkParam(tech.deplant.javapoet.TypeName refClassName, String parameterName, String origParamName, boolean hasReserved, String summary, String description, SdkObject libType, Map<ParserEngine.SdkType,SdkObject> typeLibrary)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,String>	RESERVED_FIELD_NAMES

Constructor Summary

Constructors

Constructor	Description
SdkParam(tech.deplant.javapoet.TypeName refClassName, String parameterName, String origParamName, boolean hasReserved, String summary, String description, SdkObject libType, Map<ParserEngine.SdkType,SdkObject> typeLibrary)	Creates an instance of a SdkParam record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	hasReserved()	Returns the value of the hasReserved record component.
SdkObject	libType()	Returns the value of the libType record component.
static SdkParam	ofApiType(ApiType paramType, Map<ParserEngine.SdkType,SdkObject> typeLibrary)
String	origParamName()	Returns the value of the origParamName record component.
String	parameterName()	Returns the value of the parameterName record component.
tech.deplant.javapoet.ParameterSpec.Builder	poeticize()
tech.deplant.javapoet.TypeName	refClassName()	Returns the value of the refClassName record component.
static tech.deplant.javapoet.AnnotationSpec	renamedFieldAnnotation(String originalName)
String	summary()	Returns the value of the summary record component.
final String	toString()	Returns a string representation of this record class.
Map<ParserEngine.SdkType,SdkObject>	typeLibrary()	Returns the value of the typeLibrary record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

RESERVED_FIELD_NAMES

public static final Map<String,String> RESERVED_FIELD_NAMES

Constructor Details

SdkParam

public SdkParam(tech.deplant.javapoet.TypeName refClassName,
 String parameterName,
 String origParamName,
 boolean hasReserved,
 String summary,
 String description,
 SdkObject libType,
 Map<ParserEngine.SdkType,SdkObject> typeLibrary)

Creates an instance of a SdkParam record class.

Parameters:

refClassName - the value for the refClassName record component

parameterName - the value for the parameterName record component

origParamName - the value for the origParamName record component

hasReserved - the value for the hasReserved record component

summary - the value for the summary record component

description - the value for the description record component

libType - the value for the libType record component

typeLibrary - the value for the typeLibrary record component

Method Details

ofApiType

public static SdkParam ofApiType(ApiType paramType,
 Map<ParserEngine.SdkType,SdkObject> typeLibrary)

renamedFieldAnnotation

public static tech.deplant.javapoet.AnnotationSpec renamedFieldAnnotation(String originalName)

poeticize

public tech.deplant.javapoet.ParameterSpec.Builder poeticize()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

refClassName

public tech.deplant.javapoet.TypeName refClassName()

Returns the value of the refClassName record component.

Returns:

the value of the refClassName record component

parameterName

public String parameterName()

Returns the value of the parameterName record component.

Returns:

the value of the parameterName record component

origParamName

public String origParamName()

Returns the value of the origParamName record component.

Returns:

the value of the origParamName record component

hasReserved

public boolean hasReserved()

Returns the value of the hasReserved record component.

Returns:

the value of the hasReserved record component

summary

public String summary()

Returns the value of the summary record component.

Returns:

the value of the summary record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

libType

public SdkObject libType()

Returns the value of the libType record component.

Returns:

the value of the libType record component

typeLibrary

public Map<ParserEngine.SdkType,SdkObject> typeLibrary()

Returns the value of the typeLibrary record component.

Returns:

the value of the typeLibrary record component