Module dev.metaschema.core

Package dev.metaschema.core.metapath.function

Interface IArgument

public interface IArgument

Represents a single function argument signature.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IArgument.Builder	Used to create an argument's signature using a builder pattern.

Method Summary

Modifier and Type	Method	Description
static IArgument.Builder	builder()	Get a new argument builder.
IEnhancedQName	getName()	Get the argument's name.
ISequenceType	getSequenceType()	Get information about the type of sequence supported by the argument.
static IArgument	of(IEnhancedQName name, ISequenceType sequenceType)	Create a new argument with the provided name and sequence type.
static String	resolveArgumentName(String prefix)	Resolve an argument name from a prefix.
String	toSignature()	Get the signature of the argument.

Method Details

of

@NonNull
static IArgument of(@NonNull
 IEnhancedQName name,
 @NonNull
 ISequenceType sequenceType)

Create a new argument with the provided name and sequence type.

Parameters:

name - the argument's name

sequenceType - the argument's sequence type

Returns:

a new argument instance

getName

@NonNull
IEnhancedQName getName()

Get the argument's name.

Returns:

the argument's name

getSequenceType

@NonNull
ISequenceType getSequenceType()

Get information about the type of sequence supported by the argument.

Returns:

the sequence information

toSignature

@NonNull
String toSignature()

Get the signature of the argument.

Returns:

the argument's signature

builder

@NonNull
static IArgument.Builder builder()

Get a new argument builder.

Returns:

the new argument builder

resolveArgumentName

@NonNull
static String resolveArgumentName(@NonNull
 String prefix)

Resolve an argument name from a prefix.

Parameters:

prefix - the prefix to resolve

Returns:

the resolved argument name

Throws:

UnsupportedOperationException - if a non-empty prefix is provided