Interface Connector.BooleanArgument

All Superinterfaces:: Connector.Argument, Serializable

Enclosing interface:: Connector

public static interface Connector.BooleanArgument extends Connector.Argument

Specification for and value of a Connector argument, whose value is Boolean. Boolean values are represented by the localized versions of the strings "true" and "false".

Since:: 1.3

Method Summary

Modifier and Type	Method	Description
`boolean`	`booleanValue()`	Return the value of the argument as a boolean.
`boolean`	`isValid(String value)`	Performs basic sanity check of argument.
`void`	`setValue(boolean value)`	Sets the value of the argument.
`String`	`stringValueOf(boolean value)`	Return the string representation of the `value` parameter.

Methods declared in interface Connector.Argument

description, label, mustSpecify, name, setValue, value

Modifier and Type	Method	Description
`String`	`description()`	Returns a human-readable description of this argument and its purpose.
`String`	`label()`	Returns a short human-readable label for this argument.
`boolean`	`mustSpecify()`	Indicates whether the argument must be specified.
`String`	`name()`	Returns a short, unique identifier for the argument.
`void`	`setValue(String value)`	Sets the value of the argument.
`String`	`value()`	Returns the current value of the argument.

Method Details

setValue

void setValue(boolean value)

Sets the value of the argument.

isValid

boolean isValid(String value)

Performs basic sanity check of argument.

Specified by:

isValid in interface Connector.Argument

Returns:

true if value is a string representation of a boolean value.

See Also:

stringValueOf

String stringValueOf(boolean value)

Return the string representation of the value parameter. Does not set or examine the current value of this instance.

Returns:: the localized String representation of the boolean value.

booleanValue

boolean booleanValue()

Return the value of the argument as a boolean. Since the argument may not have been set or may have an invalid value isValid(String) should be called on Connector.Argument.value() to check its validity. If it is invalid the boolean returned by this method is undefined.

Returns:: the value of the argument as a boolean.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.