ParamInfo object

Table of Contents Constructors ParamInfo Methods constructor get_name get_type get_mayBeNull get_optional get_desc toString

Constructors

ParamInfo

NAME
    ParamInfo

SYNOPSIS
    Initalizes a new ParamInfo instance
    with the specified parameter information.

SYNTAX
    <cbc.parse.ParamInfo> ParamInfo(Object info)

PARAMETERS
    -info <Object>
        An object with Parameter information. Valid properties are:

            • String name: The name of the parameter

            • [String type = null]: The type of the parameter

            • [Boolean mayBeNull = false]: True if the parameter may be null, or false otherwise

            • [Boolean optional = false]: True if it is optional to specify the parameter, or false otherwise

            • [String desc = null]: Parameter description

OUTPUTS
    <cbc.parse.ParamInfo>
        The initialized ParamInfo object.

Methods

constructor

NAME
    ParamInfo

SYNOPSIS
    Initalizes a new ParamInfo instance
    with the specified parameter information.

SYNTAX
    <cbc.parse.ParamInfo> ParamInfo(Object info)

PARAMETERS
    -info <Object>
        An object with Parameter information. Valid properties are:

            • String name: The name of the parameter

            • [String type = null]: The type of the parameter

            • [Boolean mayBeNull = false]: True if the parameter may be null, or false otherwise

            • [Boolean optional = false]: True if it is optional to specify the parameter, or false otherwise

            • [String desc = null]: Parameter description

OUTPUTS
    <cbc.parse.ParamInfo>
        The initialized ParamInfo object.

get_name

NAME
    get_name

SYNOPSIS
    Get the name of the parameter.

SYNTAX
    <String> get_name()

PARAMETERS


OUTPUTS
    <String>
        The name of the parameter.

get_type

NAME
    get_type

SYNOPSIS
    Get the type of the parameter.

SYNTAX
    <String> get_type()

PARAMETERS


OUTPUTS
    <String>
        The type of the parameter.

get_mayBeNull

NAME
    get_mayBeNull

SYNOPSIS
    Get a boolean value indicating if
    the parameter may be null or not.

SYNTAX
    <Boolean> get_mayBeNull()

PARAMETERS


OUTPUTS
    <Boolean>
        True if the parameter may be null or false.

get_optional

NAME
    get_optional

SYNOPSIS
    Get a boolean value indicating if
    the parameter is optional or not.

SYNTAX
    <Boolean> get_optional()

PARAMETERS


OUTPUTS
    <Boolean>
        True if the parameter is optional or false.

get_desc

NAME
    get_desc

SYNOPSIS
    Get the parameter's description.

SYNTAX
    <String> get_desc()

PARAMETERS


OUTPUTS
    <String>
        The parameter's description.

toString

NAME
    toString

SYNOPSIS
    Presents the ParamInfo in a PowerShell
    parameter help kind of way.

SYNTAX
    <String> toString()

PARAMETERS


OUTPUTS
    <String>
        API help for the parameter.