Deprecated API

Contents

• Interfaces
• Classes
• Exceptions
• Fields
• Methods
• Constructors
• Annotation Interface Elements

Deprecated Interfaces

Interface	Description
nz.org.riskscape.picocli.CommandLine.IExceptionHandler	see CommandLine.execute(String...), CommandLine.IParameterExceptionHandler and CommandLine.IExecutionExceptionHandler
nz.org.riskscape.picocli.CommandLine.IExceptionHandler2	see CommandLine.execute(String...), CommandLine.IParameterExceptionHandler and CommandLine.IExecutionExceptionHandler
nz.org.riskscape.picocli.CommandLine.IHelpCommandInitializable	use CommandLine.IHelpCommandInitializable2 instead
nz.org.riskscape.picocli.CommandLine.IParseResultHandler	Use CommandLine.IExecutionStrategy instead.
nz.org.riskscape.picocli.CommandLine.IParseResultHandler2	use CommandLine.IExecutionStrategy instead, see CommandLine.execute(String...)

Deprecated Classes

Class	Description
nz.org.riskscape.picocli.CommandLine.AbstractHandler	see CommandLine.execute(String...)
nz.org.riskscape.picocli.CommandLine.AbstractParseResultHandler	see CommandLine.execute(String...), CommandLine.getExecutionStrategy(), CommandLine.getParameterExceptionHandler(), CommandLine.getExecutionExceptionHandler()
nz.org.riskscape.picocli.CommandLine.DefaultExceptionHandler	see CommandLine.execute(String...), CommandLine.getParameterExceptionHandler() and CommandLine.getExecutionExceptionHandler()

Deprecated Exceptions

Exceptions	Description
nz.org.riskscape.engine.bind.UnbindableParameterException	Move over to APIs that use NoBindingAvailableException

Deprecated Fields

Field	Description
nz.org.riskscape.picocli.CommandLine.Range.isVariable	use CommandLine.Range.isVariable() instead
nz.org.riskscape.picocli.CommandLine.Range.max	use CommandLine.Range.max() instead
nz.org.riskscape.picocli.CommandLine.Range.min	use CommandLine.Range.min() instead

Deprecated Methods

Method	Description
nz.org.riskscape.engine.bind.BindingContext.bind(Parameter, String)	use BindingContext.bind(Object, Class) instead
nz.org.riskscape.engine.bind.ParameterBinder.bind(BindingContext, Parameter, String)	use ParameterBinder.bindValue(BindingContext, Object, Class) instead. Older code can use the CompatBinder to as a simple way of avoiding the deprecation warning and conforming to the new API
nz.org.riskscape.engine.data.BookmarkResolver.supportedParameters()
nz.org.riskscape.engine.function.ArgumentList.evaluateConstant(RealizationContext, FunctionCall, String, Class<T>, Type)
nz.org.riskscape.engine.IdentifiedCollection.get(String)	use IdentifiedCollection.get(String, ProblemSink) instead to make sure any warnings get picked up
nz.org.riskscape.engine.pipeline.Step.getDeclaredParameters()	use getParameterSet() instead
nz.org.riskscape.engine.plugin.Plugin.supportsFeature(Class<T>)	use the new ExtensionPoint API instead. We should start moving Features across to that as and when we touch them.
nz.org.riskscape.engine.types.Struct.build()
nz.org.riskscape.engine.types.Struct.StructBuilder.and(String, Type)	use add
nz.org.riskscape.engine.typeset.TypeSet.getRequired(String)
nz.org.riskscape.picocli.CommandLine.AbstractHandler.andExit(int)	use CommandLine.execute(String...) instead, and call System.exit() in the application.
nz.org.riskscape.picocli.CommandLine.AbstractHandler.ansi()	use CommandLine.AbstractHandler.colorScheme() instead
nz.org.riskscape.picocli.CommandLine.AbstractHandler.useAnsi(CommandLine.Help.Ansi)	use CommandLine.setColorScheme(Help.ColorScheme) and CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.AbstractHandler.useErr(PrintStream)	use CommandLine.setErr(PrintWriter) and CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.AbstractHandler.useOut(PrintStream)	use CommandLine.setOut(PrintWriter) and CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.call(C, PrintStream, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.call(C, PrintStream, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.call(C, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.call(C, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.call(Class<C>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.call(Class<C>, CommandLine.IFactory, PrintStream, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.call(Class<C>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.call(Class<C>, CommandLine.IFactory, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.Help.addSubcommand(String, Object)
nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text.append(String)	use CommandLine.Help.Ansi.Text.concat(String) instead
nz.org.riskscape.picocli.CommandLine.Help.Ansi.Text.append(CommandLine.Help.Ansi.Text)	use CommandLine.Help.Ansi.Text.concat(Text) instead
nz.org.riskscape.picocli.CommandLine.Help.detailedSynopsis(Comparator<CommandLine.Model.OptionSpec>, boolean)	use CommandLine.Help.detailedSynopsis(int, Comparator, boolean) instead.
nz.org.riskscape.picocli.CommandLine.Help.join(CommandLine.Help.Ansi, int, String[], StringBuilder, Object...)	Use CommandLine.Help.join(Ansi, int, boolean, String[], StringBuilder, Object...) instead
nz.org.riskscape.picocli.CommandLine.Help.synopsis()	use CommandLine.Help.synopsis(int) instead
nz.org.riskscape.picocli.CommandLine.Help.TextTable.cellAt(int, int)	use CommandLine.Help.TextTable.textAt(int, int) instead
nz.org.riskscape.picocli.CommandLine.HelpCommand.init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream)
nz.org.riskscape.picocli.CommandLine.IHelpCommandInitializable.init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream)
nz.org.riskscape.picocli.CommandLine.invoke(String, Class<?>, PrintStream, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.invoke(String, Class<?>, PrintStream, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.invoke(String, Class<?>, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.invoke(String, Class<?>, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.isSplitQuotedStrings()	Most applications should not change the default. The rare application that does need to split parameter values without respecting quotes should use CommandLine.Model.ParserSpec.splitQuotedStrings(boolean).
nz.org.riskscape.picocli.CommandLine.Model.ArgSpec.renderedDescription()	Use CommandLine.Model.ArgSpec.description() instead
nz.org.riskscape.picocli.CommandLine.Model.ArgSpec.setValue(T, CommandLine)	use CommandLine.Model.ArgSpec.setValue(Object) instead. This was a design mistake.
nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.Builder.help()	Use CommandLine.Model.OptionSpec.Builder.usageHelp() and CommandLine.Model.OptionSpec.Builder.versionHelp() instead.
nz.org.riskscape.picocli.CommandLine.Model.OptionSpec.help()	Use CommandLine.Model.OptionSpec.usageHelp() and CommandLine.Model.OptionSpec.versionHelp() instead.
nz.org.riskscape.picocli.CommandLine.Option.help()	Use CommandLine.Option.usageHelp() and CommandLine.Option.versionHelp() instead. See CommandLine.printHelpIfRequested(List, PrintStream, CommandLine.Help.Ansi)
nz.org.riskscape.picocli.CommandLine.parse(String...)	use CommandLine.parseArgs(String...) instead
nz.org.riskscape.picocli.CommandLine.parseWithHandler(CommandLine.IParseResultHandler2<R>, String[])	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.parseWithHandler(CommandLine.IParseResultHandler, PrintStream, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.parseWithHandlers(CommandLine.IParseResultHandler2<R>, CommandLine.IExceptionHandler2<R>, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.parseWithHandlers(CommandLine.IParseResultHandler, PrintStream, CommandLine.Help.Ansi, CommandLine.IExceptionHandler, String...)	use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
nz.org.riskscape.picocli.CommandLine.printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.Ansi)	use CommandLine.executeHelpRequest(ParseResult) instead
nz.org.riskscape.picocli.CommandLine.printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.ColorScheme)	use CommandLine.executeHelpRequest(ParseResult) instead
nz.org.riskscape.picocli.CommandLine.printHelpIfRequested(List<CommandLine>, PrintStream, CommandLine.Help.Ansi)	use CommandLine.printHelpIfRequested(ParseResult) instead
nz.org.riskscape.picocli.CommandLine.Range.defaultArity(Class<?>)	use CommandLine.Range.defaultArity(Field) instead
nz.org.riskscape.picocli.CommandLine.run(Class<R>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.run(Class<R>, CommandLine.IFactory, PrintStream, String...)	use CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.run(Class<R>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.run(Class<R>, CommandLine.IFactory, String...)	use CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.run(R, PrintStream, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.run(R, PrintStream, String...)	use CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.run(R, PrintStream, CommandLine.Help.Ansi, String...)	use CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.run(R, String...)	use CommandLine.execute(String...) instead
nz.org.riskscape.picocli.CommandLine.setSplitQuotedStrings(boolean)	Most applications should not change the default. The rare application that does need to split parameter values without respecting quotes should use CommandLine.Model.ParserSpec.splitQuotedStrings(boolean).
nz.org.riskscape.problem.Problem.composite(List<Problem>, String, Object...)	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.Problem.composite(Problem.Severity, List<Problem>, String, Object...)	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.Problem.error(String, Object...)	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.Problem.error(Throwable, String, Object...)	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.Problem.fatal(Throwable, String, Object...)	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.Problem.info(String, Object...)	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.Problem.warning(String, Object...)	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.Problem.warning(Throwable, String, Object...)	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.ResultOrProblems.composeProblems(String, Object...)	For new code, use the i18n Problem-based method below instead
nz.org.riskscape.rl.ast.StructDeclaration.Member.getAttributeName()	use getMemberName instead - the AST is no longer responsible for supplying a default member name to use when the user doesn't supply one

Deprecated Constructors

Constructor	Description
nz.org.riskscape.engine.bind.InvalidBoundParametersException(String)
nz.org.riskscape.engine.relation.InvalidTupleException(Tuple, String)
nz.org.riskscape.engine.relation.InvalidTupleException(Tuple, String, Throwable)
nz.org.riskscape.engine.RiskscapeException(String)	Use RiskscapeException(Problem) instead to produce an internationalizable error message that works with riskscape's problem API XXX do we want to split up the hierarchy somewhat in to : a) unexpected errors that are probably not recoverable/fixable and b) exceptions that are "semantic vessels for a problem" such as a NoSuchObjectExistsException - these things help us with flow control / where they serve as sort of case classes where a standard ResultOrProblems isn't sufficient, e.g. we need to do something different depending on the type of Problem. More thinking required...
nz.org.riskscape.engine.RiskscapeException(String, Throwable)	Use RiskscapeException(Problem, Throwable) instead to produce an internationalizable error message that works with riskscape's problem API
nz.org.riskscape.engine.types.RSList(Type)	use RSList.create(Type) instead - reduces the amount of identical types being allocated All Riskscape code has been ported to use create, but there may be functions etc out there that are using this old constructor. We might want to log a stack trace when this is used if it becomes functionally important that the new static constructor be used.
nz.org.riskscape.picocli.CommandLine.Help(Object, CommandLine.Help.ColorScheme)	use picocli.CommandLine.Help#Help(picocli.CommandLine.Model.CommandSpec, picocli.CommandLine.Help.ColorScheme)
nz.org.riskscape.problem.Problem(List<Problem>, Problem.Severity, String, Object[])	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.Problem(Problem.Severity, String)	use the ProblemCode-based constructor instead
nz.org.riskscape.problem.Problem(Problem.Severity, String, Object[], Throwable)	use the ProblemCode-based constructor instead

Deprecated Annotation Interface Elements

Annotation Interface Element	Description
nz.org.riskscape.picocli.CommandLine.Option.help()	Use CommandLine.Option.usageHelp() and CommandLine.Option.versionHelp() instead. See CommandLine.printHelpIfRequested(List, PrintStream, CommandLine.Help.Ansi)