Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Android::JNI::Signature< StringType > Class Template Reference

Utility for generating and validating JNI signatures. More...

#include <Signature.h>

Static Public Member Functions

static StringType Generate ()
 Required for handling cases when an empty set of variadic arguments are forwarded from AZ::Android::JNI::GetSignature calls.
 
template<typename... Args>
static StringType Generate (Args &&... parameters)
 Gets the signature from n-number of parameters.
 
static bool Validate (const StringType &baseSignature)
 Required for handling cases when an empty set of variadic arguments are forwarded from AZ::Android::JNI::ValidateSignature calls.
 
template<typename... Args>
static bool Validate (const StringType &baseSignature, Args &&... parameters)
 Validates n-number of parameters type signatures.
 

Detailed Description

template<typename StringType = AZStd::string>
class AZ::Android::JNI::Signature< StringType >

Utility for generating and validating JNI signatures.

Template Parameters
StringTypeThe type of string used internally for generation and validation. Defaults to AZStd::string

Member Function Documentation

◆ Generate() [1/2]

template<typename StringType = AZStd::string>
static StringType AZ::Android::JNI::Signature< StringType >::Generate ( )
inlinestatic

Required for handling cases when an empty set of variadic arguments are forwarded from AZ::Android::JNI::GetSignature calls.

Returns
An empty string

◆ Generate() [2/2]

template<typename StringType = AZStd::string>
template<typename... Args>
static StringType AZ::Android::JNI::Signature< StringType >::Generate ( Args &&...  parameters)
inlinestatic

Gets the signature from n-number of parameters.

Parameters
parametersVariables only used to forward their types on to AZ::Android::JNI::Signature::GenerateImpl
Returns
String containing a fully qualified Java signature

◆ Validate() [1/2]

template<typename StringType = AZStd::string>
static bool AZ::Android::JNI::Signature< StringType >::Validate ( const StringType &  baseSignature)
inlinestatic

Required for handling cases when an empty set of variadic arguments are forwarded from AZ::Android::JNI::ValidateSignature calls.

Parameters
baseSignatureThe string representation of the expected type signature. Should be an empty string in this case.
Returns
True if the string is empty (e.g. nothing to validate), false otherwise

◆ Validate() [2/2]

template<typename StringType = AZStd::string>
template<typename... Args>
static bool AZ::Android::JNI::Signature< StringType >::Validate ( const StringType &  baseSignature,
Args &&...  parameters 
)
inlinestatic

Validates n-number of parameters type signatures.

Parameters
baseSignatureThe string representation of the expected JNI type signatures in parameters
parametersThe input arguments to be validated
Returns
True if all arguments in parameters match the expected type signature in baseSignature, False otherwise

The documentation for this class was generated from the following files: