Module com.darkcollective.relix.lang.ast

Package com.darkcollective.relix.lang.ast

Record Class EnvStatement

java.lang.Object

java.lang.Record

com.darkcollective.relix.lang.ast.EnvStatement

Record Components:

filePath - path to the JSON environment file; absent uses the default

activeEnv - name of the active environment profile within the file; absent defers to the CLI flag or "development"

location - the source location of this statement; never null

All Implemented Interfaces:

Statement

public record EnvStatement(Optional<String> filePath, Optional<String> activeEnv, SourceLocation location)
extends Record
implements Statement

An env statement — declares the environment file and active profile used for credential and configuration variable resolution.

Syntax forms:

   env from './.relix-env.json' using 'development';
   env from './.relix-env.json';                      // activeEnv absent
   env using 'production';                             // filePath absent (use default path)
   env;                                                // both absent (all defaults)
 

When filePath() is absent the runtime looks for .relix-env.json in the same directory as the script. When activeEnv() is absent the environment is selected by the --env CLI flag or defaults to "development".

${VAR} placeholders in the environment file are resolved against OS environment variables.

Constructor Summary

Constructors

Constructor	Description
EnvStatement(Optional<String> filePath, Optional<String> activeEnv)	Convenience constructor for tests; uses SourceLocation.UNKNOWN.
EnvStatement(Optional<String> filePath, Optional<String> activeEnv, SourceLocation location)	Creates an instance of a EnvStatement record class.

Method Summary

Modifier and Type	Method	Description
Optional<String>	activeEnv()	Returns the value of the activeEnv record component.
static EnvStatement	defaults()	Returns an env statement with no path or environment specified (all defaults).
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<String>	filePath()	Returns the value of the filePath record component.
final int	hashCode()	Returns a hash code value for this object.
SourceLocation	location()	Returns the value of the location record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EnvStatement

public EnvStatement(Optional<String> filePath,
 Optional<String> activeEnv,
 SourceLocation location)

Creates an instance of a EnvStatement record class.

Parameters:

filePath - the value for the filePath record component

activeEnv - the value for the activeEnv record component

location - the value for the location record component

EnvStatement

public EnvStatement(Optional<String> filePath,
 Optional<String> activeEnv)

Convenience constructor for tests; uses SourceLocation.UNKNOWN.

Method Details

defaults

public static EnvStatement defaults()

Returns an env statement with no path or environment specified (all defaults).

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

filePath

public Optional<String> filePath()

Returns the value of the filePath record component.

Returns:

the value of the filePath record component

activeEnv

public Optional<String> activeEnv()

Returns the value of the activeEnv record component.

Returns:

the value of the activeEnv record component

location

public SourceLocation location()

Returns the value of the location record component.

Specified by:

location in interface Statement

Returns:

the value of the location record component