Package org.sonar.iac.docker.symbols

Class ArgumentResolution

java.lang.Object

org.sonar.iac.docker.symbols.ArgumentResolution

public class ArgumentResolution
extends Object

Class dedicated to resolving Argument, which is a complex object used to represent most parameters of instruction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArgumentResolution.Status

Constructor Summary

Constructors

Constructor	Description
ArgumentResolution(Argument argument, String value, ArgumentResolution.Status status)

Method Summary

Modifier and Type	Method	Description
Argument	argument()
boolean	isEmpty()
boolean	isResolved()
boolean	isUnresolved()
static ArgumentResolution	of(Argument argument)	Main method of the class, the point of entry to resolve Argument in order to exploit the result in checks.
static ArgumentResolution	ofWithoutStrippingQuotes(Argument argument)	The method is similar to ArgumentResolution#of but there is a control of strip quotes or double quotes in string literal.
ArgumentResolution.Status	status()
String	value()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArgumentResolution

public ArgumentResolution(@Nullable
                          Argument argument,
                          String value,
                          ArgumentResolution.Status status)

Method Detail

of

public static ArgumentResolution of(@Nullable
                                    Argument argument)

Main method of the class, the point of entry to resolve Argument in order to exploit the result in checks. In docker, most instruction can expect one or even multiple arguments, which can be a mix of strings, quotes string with spaces, variable reference with or without modifier, ect. This method will provide an ArgumentResolution object with the result of the tentative of resolution: the status and the String value. The quotes and double quotes in string literals are striped by default.

ofWithoutStrippingQuotes

public static ArgumentResolution ofWithoutStrippingQuotes(@Nullable
                                                          Argument argument)

The method is similar to ArgumentResolution#of but there is a control of strip quotes or double quotes in string literal.

value

public String value()

status

public ArgumentResolution.Status status()

argument

public Argument argument()

isResolved

public boolean isResolved()

isUnresolved

public boolean isUnresolved()

isEmpty

public boolean isEmpty()