Index

A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values

A

acceptable(int, String) - Static method in class flixw
Below MIN_JAVA is always fatal: the compiler will not run.
acceptPluginCommand(String, String, Path) - Static method in class flixw
 
acquire(flixw.Lock) - Static method in class flixw
 
artifact - Variable in record class flixw.ResolvedPlugin
The field for the artifact record component.
artifact() - Method in record class flixw.ResolvedPlugin
Returns the value of the artifact record component.
askedVersion(flixw.Lock) - Static method in class flixw
What the pinned compiler reports of itself, as pin recorded it; null when a lock predates the key and no refresh has backfilled it.
assetDir(String) - Static method in class flixw
Version-keyed, so a release's assets can be cached forever: the entry cannot go stale except by a new release, which is exactly when this path moves.
assetExists(String) - Static method in class flixw
Does this release asset exist? A HEAD, so the download itself stays a single attempt.
assetMainClass(Path) - Static method in class flixw
flixw-cli.java declares flixwcli; that is the whole convention.
assetSourceBase(String) - Static method in class flixw
Wrapper-owned, not a plugin -- fetched and verified against the release this stage 0 itself is, never installed by a user and never carrying the "3rd-party, unaudited" warning a real plugin does.
attrMacros(String) - Static method in class flixw
The macros in force for this file: git's built-in binary, plus any the file defines itself.
autoRunBoundary(List<String>) - Static method in class flixw
run <word>, with no leading flag and no -- already, can only mean a forgotten forwarding boundary for upstream Flix: unlike check/ test, where the same shape is a legitimate extra file to compile, stock run rejects a bare trailing word outright ("does not support file arguments") rather than trying to load it.
awaitWithReaper(Process) - Static method in class flixw
Waits for a child that owns the terminal, and guarantees it dies with us.

B

backfillCommand(Path, Path) - Static method in class flixw
Writes the verb an already-installed plugin declares, reading its jar once.
bracketDelta(String) - Static method in class flixw
How much this line opens or closes an inline array, counting only brackets outside quotes.
BUILTIN_VERBS - Static variable in class flixw
Fallback verbs from Flix 0.77.0.

C

Cached(Path, String, String) - Constructor for record class flixw.Cached
Creates an instance of a Cached record class.
cachedFor(String, String, flixw.Lock) - Static method in class flixw
The cached jar an earlier pin or run fetched for exactly this repository and version, or null -- and then pin downloads, as it always did.
cachedJdkDirs() - Static method in class flixw
<cache>/jdks/*: the trees the provisioner unpacked.
cachedPinRecord(String) - Static method in class flixw
What acquire last wrote for this digest, if any -- a file read, never a subprocess or a re-parse of anyone's lock.
cacheHome() - Static method in class flixw
 
canonical(String) - Static method in class flixw
The single normalization used for release tags, cache coordinates, and every version comparison.
canonicalAttrs(String) - Static method in class flixw
The line endings the flixw block pins for one shipped path.
captureHelp(Path, Path) - Static method in class flixw
The compiler's `--help`, bounded, as text.
captureReportedVersion(Path, String) - Static method in class flixw
Asks a JAR what version it says it is, for the lock.
captureVerbs(String, Path) - Static method in class flixw
 
changed - Variable in record class flixw.Refresh
The field for the changed record component.
changed() - Method in record class flixw.Refresh
Returns the value of the changed record component.
changesEndings(String, String, Map<String, String>) - Static method in class flixw
Does a later rule leave text or eol saying something other than the block does? git resolves attributes one at a time, so a rule reaches only those it names: the block sets linguist-vendored beside the endings, and a project that turns that back off has not touched what this check protects.
check(Path, flixw.Lock, Path, flixw.Jvm) - Static method in class flixw
Every check, printed; the count is the caller's to act on.
checkCanonical(Path, String, String) - Static method in class flixw
Compares an installed file with the bytes this release ships, by digest.
checkGitattributes(Path) - Static method in class flixw
gitattributes resolves by *last* matching pattern, so a rule after the wrapper block silently overrides it -- and a checked-out shim with the wrong line endings is exactly the failure the block exists to prevent.
checkRepo(String, String) - Static method in class flixw
 
chooseInstall(List<flixw.Jvm>, boolean) - Static method in class flixw
Picks among discovered installations: the newest JDK that is still inside the tested interval, and only if none is, the one just above it.
clearJava - Variable in record class flixw.Pin
The field for the clearJava record component.
clearJava() - Method in record class flixw.Pin
Returns the value of the clearJava record component.
clearLocalCompiler(Path) - Static method in class flixw
 
CLI_ASSET - Static variable in class flixw
CMD_SHA256 - Static variable in class flixw
 
cmdQuote(String) - Static method in class flixw
cmd.exe's own quoting convention for one command-line word: wrap in double quotes if it needs it, doubling any quote already inside.
code - Variable in exception class flixw.Fail
 
command - Variable in record class flixw.PluginDep
The field for the command record component.
command() - Method in record class flixw.PluginDep
Returns the value of the command record component.
COMMAND_ENTRY - Static variable in class flixw
Two-space indent, a lowercase name, then the column gap before its description.
commandOwner(flixw.Lock, String) - Static method in class flixw
Which plugin, if any, declared verb in this lock.
compileAsset(Path, Path) - Static method in class flixw
Compiles an asset once per content hash, or returns null to source-launch it.
compiledAssetDir(String) - Static method in class flixw
<cache>/assets/<sha256 of source>/, content-keyed exactly like stage 0's own.
compilerPath(flixw.Lock) - Static method in class flixw
 
compilerVerbHelp(String, String, Path, flixw.Lock, Path, flixw.Jvm, List<String>, String, List<String>) - Static method in class flixw
On renderer failure, launch the original compiler argv.
COMPLETION_SHELLS - Static variable in class flixw
 
COMPLETION_USAGE - Static variable in class flixw
 
completionEarly(List<String>) - Static method in class flixw
completion, answered before the project is resolved -- and enriched from the cache if there is one.
completionScript(List<String>, Path, flixw.Lock, Path, flixw.Jvm, List<String>, String) - Static method in class flixw
The project-independent completer, on stdout.
completionShell(List<String>) - Static method in class flixw
The one shell name in these arguments, validated.
count(String, String) - Static method in class flixw
 

D

deleteTree(Path) - Static method in class flixw
 
description - Variable in record class flixw.PluginDep
The field for the description record component.
description() - Method in record class flixw.PluginDep
Returns the value of the description record component.
diagnostic(String) - Static method in class flixw
Verbs that must answer even when no java satisfies the lock.
digest - Variable in record class flixw.Cached
The field for the digest record component.
digest() - Method in record class flixw.Cached
Returns the value of the digest record component.
digestFor(String, String) - Static method in class flixw
The digest a SHA256SUMS file names for one file, or null if it does not.
dirsIn(Path) - Static method in class flixw
Directories directly under dir, sorted; empty when it is not one.
dispatchLocal(Path, flixw.Lock, Path, flixw.Jvm, boolean, List<String>, List<String>, String) - Static method in class flixw
The local asset serves both local and examples local.
DOCTOR_USAGE - Static variable in class flixw
 
download(String, Path) - Static method in class flixw
 
downloadAdvice(int) - Static method in class flixw
A 5xx is the host failing; sending that user to re-read their pin is a false lead.

E

editorJar - Variable in record class flixw.Pin
The field for the editorJar record component.
editorJar() - Method in record class flixw.Pin
Returns the value of the editorJar record component.
EditorJarPref(String, String) - Constructor for record class flixw.EditorJarPref
Creates an instance of a EditorJarPref record class.
editorJarPrefsFile(Path) - Static method in class flixw
.flixw/local/editor-jar.toml: a per-machine preference for how ./flix.jar -- the file the official VS Code Flix extension checks for at a workspace root, before its own global cache and before it ever downloads anything itself -- is kept in sync with the pin.
encodeTag(String) - Static method in class flixw
A release tag in a URL path.
ensureAsset(String) - Static method in class flixw
 
ensureAsset(String, String) - Static method in class flixw
The version is a parameter because wrapper --upgrade warms the assets of the release it is upgrading *to*, from the stage 0 it is upgrading *from*.
ensureGitignored(Path, String) - Static method in class flixw
One line, appended if missing -- /flix.jar is generated, machine-specific state, the same reason .flixw/local/ itself is never committed.
entries - Variable in record class flixw.TomlScan
The field for the entries record component.
entries() - Method in record class flixw.TomlScan
Returns the value of the entries record component.
env(String) - Static method in class flixw
 
equals(Object) - Method in record class flixw.Cached
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.EditorJarPref
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.Jvm
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.LocalCompiler
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.Lock
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.LockField
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.Pin
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.PinRecord
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.PluginDep
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.Refresh
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.ResolvedPlugin
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.TomlEntry
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class flixw.TomlScan
Indicates whether some other object is "equal to" this one.
esc(String) - Static method in class flixw
Escapes a value for the tab-separated rows above.
exactCompilerHelp(List<String>) - Static method in class flixw
 
EXAMPLES_ASSET - Static variable in class flixw
EXAMPLES_LOCAL_USAGE - Static variable in class flixw
 
EXAMPLES_USAGE - Static variable in class flixw
 
exe - Variable in record class flixw.Jvm
The field for the exe record component.
exe() - Method in record class flixw.Jvm
Returns the value of the exe record component.
exeIn(String) - Static method in class flixw
 
exit - Variable in exception class flixw.Fail
 
extractTagName(String) - Static method in class flixw
The first "tag_name" value in a GitHub releases API response, or null.

F

fail(String, int, String) - Static method in class flixw
 
Fail(String, int, String) - Constructor for exception class flixw.Fail
 
feature - Variable in record class flixw.Jvm
The field for the feature record component.
feature() - Method in record class flixw.Jvm
Returns the value of the feature record component.
feature(String) - Static method in class flixw
 
fetch - Variable in record class flixw.Pin
The field for the fetch record component.
fetch() - Method in record class flixw.Pin
Returns the value of the fetch record component.
fetchedFrom(String) - Static method in class flixw
Every URL these exact bytes were actually downloaded from and verified against, one per line -- what pin may reuse a cached jar as, and nothing else.
fieldJson(flixw.LockField, String) - Static method in class flixw
 
fileUrlHint(String) - Static method in class flixw
Says what is wrong with a file:// URL that a shell wrote and a JVM cannot read.
findJavaUnder(Path) - Static method in class flixw
Layout differs per platform -- macOS nests a .jdk bundle -- so look rather than guess.
findPluginArtifact(Path) - Static method in class flixw
 
findRoot(Path) - Static method in class flixw
Search upward from cwd for flix.toml, bounded above by the wrapper's own project.
flixw - Class in Unnamed Package
Stage 0 of the flixw bootstrap: one file, no dependencies, Java 21.
flixw() - Constructor for class flixw
 
flixw.Cached - Record Class in Unnamed Package
A compiler already in the cache that pin can reuse, with where it came from.
flixw.EditorJarPref - Record Class in Unnamed Package
 
flixw.Fail - Exception Class in Unnamed Package
 
flixw.Jvm - Record Class in Unnamed Package
 
flixw.LocalCompiler - Record Class in Unnamed Package
 
flixw.Lock - Record Class in Unnamed Package
 
flixw.LockField - Record Class in Unnamed Package
One key in lock.toml: the table it lives in, whether that table may omit it, the shape its value must have, and the sentence a diagnostic uses to describe it.
flixw.Pin - Record Class in Unnamed Package
Parsed pin request; local selection never replaces the committed release fallback.
flixw.PinRecord - Record Class in Unnamed Package
What a lock pinned this digest as: the exact tag and repository, not what the compiler chooses to say about itself.
flixw.PluginDep - Record Class in Unnamed Package
A plugin dependency the project declares: not a fetch instruction, only a record of what flixw plugin install verified when someone last ran it.
flixw.Refresh - Record Class in Unnamed Package
Whether the lock was rewritten, and the sentence explaining why not when it was not.
flixw.ResolvedPlugin - Record Class in Unnamed Package
One resolved, digest-verified plugin build, ready to launch.
flixw.TomlEntry - Record Class in Unnamed Package
One `key = value` occurrence, the table it was found in, and the line it sits on.
flixw.TomlScan - Record Class in Unnamed Package
Every scalar entry in a document, plus every table header, in file order.
forkAssets(String, String) - Static method in class flixw
A fork's two asset conventions, flix-<version>.jar and flix.jar.

G

GH_ASSET - Static variable in class flixw
A GitHub release asset URL, split so only the tag has to change to find a newer one.
git(Path, String...) - Static method in class flixw
Runs git <args> in root; null when git is absent or the command fails to start.

H

hashCode() - Method in record class flixw.Cached
Returns a hash code value for this object.
hashCode() - Method in record class flixw.EditorJarPref
Returns a hash code value for this object.
hashCode() - Method in record class flixw.Jvm
Returns a hash code value for this object.
hashCode() - Method in record class flixw.LocalCompiler
Returns a hash code value for this object.
hashCode() - Method in record class flixw.Lock
Returns a hash code value for this object.
hashCode() - Method in record class flixw.LockField
Returns a hash code value for this object.
hashCode() - Method in record class flixw.Pin
Returns a hash code value for this object.
hashCode() - Method in record class flixw.PinRecord
Returns a hash code value for this object.
hashCode() - Method in record class flixw.PluginDep
Returns a hash code value for this object.
hashCode() - Method in record class flixw.Refresh
Returns a hash code value for this object.
hashCode() - Method in record class flixw.ResolvedPlugin
Returns a hash code value for this object.
hashCode() - Method in record class flixw.TomlEntry
Returns a hash code value for this object.
hashCode() - Method in record class flixw.TomlScan
Returns a hash code value for this object.
HEADER_LINES - Static variable in class flixw
How much of a help screen counts as the header for flixw.parseReportedVersion(java.lang.String).
HELP_CAP - Static variable in class flixw
 
HELP_TIMEOUT - Static variable in class flixw
 
helpContext(Path, flixw.Lock, Path, flixw.Jvm, List<String>, String, boolean) - Static method in class flixw
helpFile(String) - Static method in class flixw
The compiler's --help, verbatim, beside the verb record and keyed the same way.
helpMetaFile(String) - Static method in class flixw
Provenance for flixw.helpFile(java.lang.String): what the compiler called itself, what was stored, and when it was asked.
helpTopic(List<String>, Path, flixw.Lock, Path, flixw.Jvm, List<String>, String, List<String>, boolean) - Static method in class flixw
Only interactive help may degrade.
how - Variable in record class flixw.Jvm
The field for the how record component.
how() - Method in record class flixw.Jvm
Returns the value of the how record component.
httpClient() - Static method in class flixw
The one HTTP client, pinned to HTTP/1.1.
httpGet(String) - Static method in class flixw
One bounded HTTPS GET returning text.
humanSize(long) - Static method in class flixw
A byte count as a person reads it; cached JARs and JDKs are always well above 1 KB.

I

INFO_USAGE - Static variable in class flixw
 
insideCompilerCache(Path) - Static method in class flixw
True when a path names something inside the cache flixw fills with pinned compilers.
INSPECT_ASSET - Static variable in class flixw
The cache inventory behind info --verbose; see flixw.listCache(flixw.Lock, flixw.Jvm).
inspectContext(flixw.Lock, flixw.Jvm) - Static method in class flixw
What the inspector is told, as opposed to what it looks up.
installedCommandOwner(String) - Static method in class flixw
The installed plugin that claims this verb, for a project that declares none.
installedJdk() - Static method in class flixw
The java recorded by the last successful install, if it is still there.
installedPlugins() - Static method in class flixw
Every installed plugin, newest version first, as the cache knows it.
installJdkVerb(List<String>) - Static method in class flixw
`./flixw wrapper --install-jdk`, so the choice need not wait for a failure.
isHelpFlag(String) - Static method in class flixw
 
isKey(flixw.TomlEntry, String, String) - Static method in class flixw
True when an entry is `table.key`.
isMac() - Static method in class flixw
 
isUpstream(flixw.Lock, boolean) - Static method in class flixw
Whether a fact verified against upstream Flix's own behaviour -- not its rendered --help layout, which any fork can reproduce trivially -- is safe to apply here.
isWindows() - Static method in class flixw
 

J

jar - Variable in record class flixw.Cached
The field for the jar record component.
jar() - Method in record class flixw.Cached
Returns the value of the jar record component.
java - Variable in record class flixw.Lock
The field for the java record component.
java - Variable in record class flixw.Pin
The field for the java record component.
java() - Method in record class flixw.Lock
Returns the value of the java record component.
java() - Method in record class flixw.Pin
Returns the value of the java record component.
JAVA_PIN_PATTERN - Static variable in class flixw
A feature release or an exact one, and nothing else -- no ranges, no vendor.
javaHomeOf(Path) - Static method in class flixw
exe's JDK home: two directories up from bin/java.
javaPinAvailable(String) - Static method in class flixw
Is there a JDK on this machine that satisfies the pin? Asked by `pin` so that writing one is not silently a decision to break the next command.
JDK_ASSET - Static variable in class flixw
The optional JDK provisioner; see flixw.runJdkAsset(int).
jdkInstructions(int) - Static method in class flixw
What to type on this OS, pointing at the same vendor flixw would fetch.
jsonArray(List<String>) - Static method in class flixw
 
jsonString(String) - Static method in class flixw
JSON string literal.
Jvm(Path, int, String) - Constructor for record class flixw.Jvm
Creates an instance of a Jvm record class.
jvmOpts() - Static method in class flixw
 

K

key - Variable in record class flixw.LockField
The field for the key record component.
key - Variable in record class flixw.TomlEntry
The field for the key record component.
key() - Method in record class flixw.LockField
Returns the value of the key record component.
key() - Method in record class flixw.TomlEntry
Returns the value of the key record component.
knownInstalls() - Static method in class flixw
Directories a JDK is commonly unpacked into.

L

latestBase() - Static method in class flixw
Where wrapper --upgrade looks for the newest release.
latestPrereleaseTag() - Static method in class flixw
The tag_name of the single most recently published flixw release, whether or not it is a pre-release -- which is the one thing /releases/latest cannot say, by GitHub's own design.
latestTag(String) - Static method in class flixw
The tag /releases/latest redirects to, which needs no API token or quota.
launch(Path, List<String>, Path, List<String>) - Static method in class flixw
Inherit cwd and the three streams; propagate the child's status.
line - Variable in record class flixw.TomlEntry
The field for the line record component.
line() - Method in record class flixw.TomlEntry
Returns the value of the line record component.
listCache(flixw.Lock, flixw.Jvm) - Static method in class flixw
The cache inventory info --verbose prints, rendered by a companion asset.
LOCAL_ASSET - Static variable in class flixw
Overrides a declared GitHub dependency with a local checkout; see the "local" case in flixw.wrapperVerb(java.lang.String, java.util.List<java.lang.String>, java.nio.file.Path, flixw.Lock, java.nio.file.Path, flixw.Jvm, java.util.List<java.lang.String>, java.lang.String) and the examples local routing in the "examples" case.
LOCAL_BOOKKEEPING_VERBS - Static variable in class flixw
Bookkeeping verbs work before a compiler is pinned, like plugin install.
LOCAL_USAGE - Static variable in class flixw
 
LocalCompiler(Path, String) - Constructor for record class flixw.LocalCompiler
Creates an instance of a LocalCompiler record class.
localCompilerFile(Path) - Static method in class flixw
Mutable local state; lock.toml remains the committed, verified fallback.
localHelpArgs(List<String>, Path, flixw.Lock, Path, flixw.Jvm, List<String>, String) - Static method in class flixw
 
localHelpSubcommand(String) - Static method in class flixw
 
localJar - Variable in record class flixw.Pin
The field for the localJar record component.
localJar() - Method in record class flixw.Pin
Returns the value of the localJar record component.
Lock(String, String, String, String, String, String, Map<String, flixw.PluginDep>) - Constructor for record class flixw.Lock
Creates an instance of a Lock record class.
LOCK_SCHEMA - Static variable in class flixw
Every key a lock may hold, in the order a generated lock writes them.
LOCK_SCHEMA_URL - Static variable in class flixw
The URL written into every generated lock as a `#:schema` directive, and the `$id` of the schema itself.
LOCK_SCHEMA_VERSION - Static variable in class flixw
The lock format's major version, which is not the wrapper's.
LockField(String, String, boolean, String, String) - Constructor for record class flixw.LockField
Creates an instance of a LockField record class.
lockFields(String) - Static method in class flixw
The fields declared for one table, in lock order.
lockIfAny() - Static method in class flixw
 
lockPath(Path) - Static method in class flixw
 
lockSchemaJson() - Static method in class flixw
The published JSON Schema for lock.toml, rendered from flixw.LOCK_SCHEMA.
lockTables() - Static method in class flixw
The tables the schema knows about, deduplicated, in lock order.
lockText(String, String, String, String, String, String, String, Map<String, flixw.PluginDep>) - Static method in class flixw
 

M

main(String[]) - Static method in class flixw
The one entry point.
maintainEditorJar(Path, Path, String) - Static method in class flixw
Keeps ./flix.jar pointing at exactly the JAR this pin just verified, for the one consumer that looks for it: the official VS Code Flix extension, which checks a workspace root before its own global cache and before it ever downloads anything.
manifestVersion(Path) - Static method in class flixw
The manifest is the human authority; disagreement stops us before the network.
markJvmUse(flixw.Jvm) - Static method in class flixw
Records a provisioned JDK only after it won selection, never merely because it was probed.
markUsed(String) - Static method in class flixw
A flixw-owned last-use record, deliberately independent of filesystem atime.
METADATA_CAP - Static variable in class flixw
Adoptium answers in a few tens of KiB; this is room to spare, not a target.
MILL_COMPILER_JAR - Static variable in class flixw
The one output produced by Flix's supported Mill assembly task.
MIN_JAVA - Static variable in class flixw
 
mode - Variable in record class flixw.EditorJarPref
The field for the mode record component.
mode() - Method in record class flixw.EditorJarPref
Returns the value of the mode record component.
multiline - Variable in record class flixw.TomlEntry
The field for the multiline record component.
multiline() - Method in record class flixw.TomlEntry
Returns the value of the multiline record component.

N

name() - Method in record class flixw.LockField
How a diagnostic names this key: `[compiler] sha256`, or a bare key at the root.
newerAsset(String, String) - Static method in class flixw
The same asset in that repository's newest release, or null if there is no newer one.
noJavaFound(int, String) - Static method in class flixw
Nothing usable was found: say how to fix it, and stop.
NOTED_LOCKS - Static variable in class flixw
Locks already reported on, so a second read in the same run stays quiet.
noteUnknownLockKeys(String, String, String) - Static method in class flixw
Keys the schema does not describe, reported once and never fatally.
num(String) - Static method in class flixw
 

O

offlineHelp(String, Exception) - Static method in class flixw
Help with no renderer: the routing table, then the compiler's own captured help.
olderOrSame(String, String) - Static method in class flixw
Is `a` no newer than `b`? Both are the wrapper's own dotted versions.
ownsEditorJar(Path, flixw.EditorJarPref) - Static method in class flixw
Whether link is a file this project's own flixw put there -- a symlink resolving into this machine's compiler cache, or a regular file (a copy, or a hard link, indistinguishable from one on disk) whose digest matches what was last recorded here.
ownsEditorJar(Path, flixw.EditorJarPref, Path) - Static method in class flixw
Also recognizes a selected local link, including one broken by a clean build.

P

pad(String, int) - Static method in class flixw
 
PAGES_BASE - Static variable in class flixw
Where the generated documentation and the JSON Schema are published.
parsePin(List<String>, flixw.Lock) - Static method in class flixw
./flixw pin [<owner>/<repo>] [<version>] [--java <version>], or ./flixw pin --refresh.
parseReportedVersion(String) - Static method in class flixw
The version the compiler says it is, read from the header of its own help.
parseVerbs(String) - Static method in class flixw
The verbs a help screen advertises, by three independent parses.
path - Variable in record class flixw.LocalCompiler
The field for the path record component.
path() - Method in record class flixw.LocalCompiler
Returns the value of the path record component.
pattern - Variable in record class flixw.LockField
The field for the pattern record component.
pattern() - Method in record class flixw.LockField
Returns the value of the pattern record component.
patternMatches(String, String) - Static method in class flixw
Does one .gitattributes pattern match one path flixw ships?
PICOCLI_ASSET - Static variable in class flixw
 
PICOCLI_VERSION - Static variable in class flixw
picocli, published as a flixw release asset like every other companion.
pin(Path, flixw.Pin) - Static method in class flixw
 
Pin(String, String, String, boolean, boolean, String, String, boolean, boolean) - Constructor for record class flixw.Pin
Creates an instance of a Pin record class.
PIN_USAGE - Static variable in class flixw
One usage line for `pin`, because four diagnostics quote it and the fourth was already a release behind the first the last time one was written out by hand.
PinRecord(String, String) - Constructor for record class flixw.PinRecord
Creates an instance of a PinRecord record class.
pinRecordFile(String) - Static method in class flixw
Beside the version record and keyed the same way, so a re-pin gets a fresh one.
PLUGIN_NAME_PATTERN - Static variable in class flixw
A single path segment, nothing else -- in particular no `.`, so a name can never climb out of <cache>/plugins/ the way .. would.
PLUGIN_USAGE - Static variable in class flixw
 
pluginAttribute(Path, String, int, String) - Static method in class flixw
 
pluginCacheDir(String) - Static method in class flixw
Where a plugin may keep derived data between runs.
PluginDep(String, String, String, String, String) - Constructor for record class flixw.PluginDep
Creates an instance of a PluginDep record class.
pluginDir(String, String, String) - Static method in class flixw
 
pluginEnv(Path, flixw.Lock, flixw.Jvm, Path, String, flixw.ResolvedPlugin, List<String>) - Static method in class flixw
The context a plugin ABI version 1 promises: a flat environment-variable tier for the common case, plus FLIXW_CONTEXT naming a versioned JSON file for anything structured.
pluginInstall(Path, List<String>) - Static method in class flixw
The only path a plugin's bytes reach the machine -- explicit, one attempt, same shape as flixw.acquire(flixw.Lock) for the compiler.
pluginList(flixw.Lock) - Static method in class flixw
 
pluginRemove(List<String>) - Static method in class flixw
 
plugins - Variable in record class flixw.Lock
The field for the plugins record component.
plugins() - Method in record class flixw.Lock
Returns the value of the plugins record component.
pluginsDir() - Static method in class flixw
 
pluginsTableJson(String) - Static method in class flixw
[plugins.<name>] for every name at once: an object whose keys are arbitrary (plugin names) but whose values all share one shape, which JSON Schema expresses with additionalProperties as a sub-schema rather than properties.
pluginUpgrade(Path, List<String>) - Static method in class flixw
Moves every plugin this project declares, or one named, to its newest release.
pluginVersionOf(Path) - Static method in class flixw
The version half of a <version>-<sha256> plugin directory name.
printAligned(List<String[]>) - Static method in class flixw
Prints a two-column list with its first two columns aligned, so that a listing whose entries vary wildly in length -- 0.75.2 beside 0.75.3+stable.names.4 -- reads as a table instead of a ragged column of annotations nobody can scan.
probe(Path) - Static method in class flixw
Reads <home>/release when present and parseable; else runs the candidate once.
PROBE_TIMEOUT - Static variable in class flixw
Bounds for the two child processes stage 0 runs for information rather than for work.
probeVersion(Path) - Static method in class flixw
The candidate's own version string -- `21.0.12` rather than `21` -- so a pin can be as exact as the person who wrote it chose to be.
publishedAssets(String) - Static method in class flixw
Every companion asset a release publishes, read out of that release's own SHA256SUMS rather than from a list in here.
purgeCache(int, boolean) - Static method in class flixw
Runs the cache lifecycle half of the inspector without requiring a project.

Q

q(String) - Static method in class flixw
 

R

readEditorJarPref(Path) - Static method in class flixw
 
readLocalCompiler(Path) - Static method in class flixw
A malformed selection is fatal, never an implicit switch to another compiler.
readLocalOverrides(Path) - Static method in class flixw
The coordinates .flixw/local/packages.toml names, for check's advisory line -- not a general reader.
readLock(Path) - Static method in class flixw
 
readLockFields(String, String) - Static method in class flixw
Reads every key flixw.LOCK_SCHEMA declares, keyed as `table.key` with the root table's keys unprefixed.
readPlugins(String, String) - Static method in class flixw
[plugins.<name>] tables, keyed by name -- a dynamic set `LOCK_SCHEMA`'s fixed-table-and-key model cannot describe, so it is read directly from flixw.tomlScan(java.lang.String, java.lang.String) rather than through flixw.readLockFields(java.lang.String, java.lang.String).
readSums(String) - Static method in class flixw
The digest manifest for one release base, from wherever that base points.
readTasks(Path) - Static method in class flixw
`.flixw/tasks.toml`: npm-`scripts`-style name-to-shell-string pairs, hand-edited and committed like `lock.toml` itself, but never generated or rewritten by `pin` or `doctor --fix` -- unlike the lock, this file is the human's to write, so it carries no `#:schema` directive and no "generated" header.
realMain(List<String>) - Static method in class flixw
 
recordFetch(String, String) - Static method in class flixw
Adds url to flixw.fetchedFrom(java.lang.String); best-effort, like every cache write.
recordJava(Path, Path) - Static method in class flixw
Leaves the shim a note saying which JDK this project resolved to, so the next run can start on it instead of starting on whatever `java` is first on PATH and then relaunching.
recordPluginInLock(Path, String, String, String, String, String, String) - Static method in class flixw
 
redact(String) - Static method in class flixw
Redacts credentials from a URL-shaped value before it is printed.
redactOpts(String) - Static method in class flixw
The same, for JVM option strings, which can carry -Dhttps.proxyPassword=secret.
refresh - Variable in record class flixw.Pin
The field for the refresh record component.
refresh() - Method in record class flixw.Pin
Returns the value of the refresh record component.
Refresh(boolean, String) - Constructor for record class flixw.Refresh
Creates an instance of a Refresh record class.
refreshLock(Path) - Static method in class flixw
 
refreshPin(Path) - Static method in class flixw
`./flixw pin --refresh`.
relaunch(flixw.Jvm, List<String>) - Static method in class flixw
At most one relaunch, guarded by an env marker, so a stale release file cannot loop.
releaseBase(String) - Static method in class flixw
Where one release's assets live: a named version's, or whatever latest means.
RELEASES_API - Static variable in class flixw
Where flixw.latestPrereleaseTag() asks, since there is no /latest for it.
renderHelp(List<String>, Path, flixw.Lock, Path, flixw.Jvm, List<String>, String, List<String>) - Static method in class flixw
Runs the renderer and deletes its context.
renderWrapperHelp(String, String, Path, flixw.Lock, Path, flixw.Jvm, List<String>, String, List<String>) - Static method in class flixw
 
renderWrapperHelp(List<String>, String, Path, flixw.Lock, Path, flixw.Jvm, List<String>, String, List<String>) - Static method in class flixw
 
repo - Variable in record class flixw.Lock
The field for the repo record component.
repo - Variable in record class flixw.Pin
The field for the repo record component.
repo - Variable in record class flixw.PinRecord
The field for the repo record component.
repo() - Method in record class flixw.Lock
Returns the value of the repo record component.
repo() - Method in record class flixw.Pin
Returns the value of the repo record component.
repo() - Method in record class flixw.PinRecord
Returns the value of the repo record component.
REPO_PATTERN - Static variable in class flixw
GitHub's own limits on the two path segments; a fork may live anywhere within them.
report(Path, flixw.Lock, Path, flixw.Jvm, List<String>, String) - Static method in class flixw
 
reportedVersion - Variable in record class flixw.Lock
The field for the reportedVersion record component.
reportedVersion() - Method in record class flixw.Lock
Returns the value of the reportedVersion record component.
reportOverrideGap(flixw.Lock, Path) - Static method in class flixw
Says so when FLIX_JAR names a compiler out of flixw's own cache.
reportVersionGap(String, String, String) - Static method in class flixw
Says so when the two version strings recorded about one compiler disagree.
required - Variable in record class flixw.LockField
The field for the required record component.
required() - Method in record class flixw.LockField
Returns the value of the required record component.
ResolvedPlugin(String, String, Path) - Constructor for record class flixw.ResolvedPlugin
Creates an instance of a ResolvedPlugin record class.
resolveLinkChain(Path) - Static method in class flixw
 
resolvePlugin(String, flixw.Lock) - Static method in class flixw
 
resolveRelease(String, String) - Static method in class flixw
 
restore(Path, String) - Static method in class flixw
Best-effort rollback; a failed restore must not mask the failure being reported.
rewriteBase(String) - Static method in class flixw
 
rootIfAny() - Static method in class flixw
This project's root, or null when there is no project here.
routingNotice(String, String) - Static method in class flixw
Which side handled a verb, under FLIXW_TRACE only.
runArtifact(Path, Path, Path, List<String>, Map<String, String>) - Static method in class flixw
Launches one plugin artifact as an opaque subprocess, inheriting cwd and the three streams exactly like flixw.launch(java.nio.file.Path, java.util.List<java.lang.String>, java.nio.file.Path, java.util.List<java.lang.String>) does for the compiler -- three formats, one launcher, because a plugin is not otherwise different from the compiler stage 0 already knows how to run.
runAsset(Path, Path, Path, List<String>) - Static method in class flixw
resources joins the loader's class path only: data, so never compiled against.
runAsset(Path, Path, List<String>) - Static method in class flixw
Runs a companion asset, in this JVM when it can be and in its own when it cannot.
runCapture(List<String>, Duration, int) - Static method in class flixw
Runs a child and returns its merged output, bounded in both bytes and wall clock.
runDeclaredPlugin(String, String, List<String>, Path, flixw.Lock, Path, flixw.Jvm) - Static method in class flixw
Runs the plugin that declared this verb, saying which one answered.
runJdkAsset(int) - Static method in class flixw
Fetches, verifies and runs the JDK provisioner, and returns the java it installed -- the one line the asset prints on stdout.
runningJvm() - Static method in class flixw
The JVM already executing this code, which is by construction usable.
runSetupAsset(List<String>) - Static method in class flixw
Runs the installer asset, fetching and verifying it first.
runTask(String, List<String>) - Static method in class flixw
Runs a task's shell string via the platform shell, inheriting cwd and the three streams exactly like a plugin or the compiler does.

S

sanitize(String, int) - Static method in class flixw
A manifest value made safe to print and to store.
satisfiesJavaPin(String, String) - Static method in class flixw
Does this JDK satisfy `[java] version` in the lock? A pin is a prefix of the version, cut at a dot: `21` accepts 21.0.12, `21.0` accepts 21.0.12, and neither accepts 21.1 or 2.
selectedSha256 - Variable in record class flixw.LocalCompiler
The field for the selectedSha256 record component.
selectedSha256() - Method in record class flixw.LocalCompiler
Returns the value of the selectedSha256 record component.
selectJava(String) - Static method in class flixw
 
selectLocalCompiler(Path, String) - Static method in class flixw
Resolves either a built compiler JAR or a Flix checkout containing Mill's output.
selfCompile(Path) - Static method in class flixw
Compiles this source into the cache so the shim can skip the JEP 330 source launch next time.
selfSource() - Static method in class flixw
 
SEMVERISH - Static variable in class flixw
 
serialVersionUID - Static variable in exception class flixw.Fail
 
SETUP_ASSET - Static variable in class flixw
sha256 - Variable in record class flixw.EditorJarPref
The field for the sha256 record component.
sha256 - Variable in record class flixw.Lock
The field for the sha256 record component.
sha256 - Variable in record class flixw.PluginDep
The field for the sha256 record component.
sha256 - Variable in record class flixw.ResolvedPlugin
The field for the sha256 record component.
sha256() - Method in record class flixw.EditorJarPref
Returns the value of the sha256 record component.
sha256() - Method in record class flixw.Lock
Returns the value of the sha256 record component.
sha256() - Method in record class flixw.PluginDep
Returns the value of the sha256 record component.
sha256() - Method in record class flixw.ResolvedPlugin
Returns the value of the sha256 record component.
sha256(byte[]) - Static method in class flixw
 
sha256(Path) - Static method in class flixw
 
SHIM_SHA256 - Static variable in class flixw
 
SHIPPED - Static variable in class flixw
Every path the installer writes and the project commits — the set the block pins and the set git has to carry.
source - Variable in record class flixw.PluginDep
The field for the source record component.
source() - Method in record class flixw.PluginDep
Returns the value of the source record component.
SOURCE_FLOOR - Static variable in class flixw
The oldest javac that can compile this file, which is a different number from the floor above and answers a different question.
sourceLaunchPath() - Static method in class flixw
The .java file this stage 0 was launched from, or null when it is running as the compiled class out of the cache.
SPECS_ASSET - Static variable in class flixw
Curated Flix command specs for the renderer's class path: flixw's data, so a flixw release rather than picocli's.
splitKey(String, String) - Static method in class flixw
Splits a key into its segments, respecting quotes, then unquotes and trims each one.
stage0Dir(String) - Static method in class flixw
 
stock - Variable in record class flixw.Pin
The field for the stock record component.
stock() - Method in record class flixw.Pin
Returns the value of the stock record component.
storedHelp(String) - Static method in class flixw
The stored help for this compiler, re-verified against its own provenance record.
strictJava() - Static method in class flixw
 
strip(String) - Static method in class flixw
v1.2.3 and 1.2.3 name one release; the lock records the second.
stripComment(String) - Static method in class flixw
Strips a trailing comment, ignoring '#' inside quotes.
stripTagPrefix(String) - Static method in class flixw
Accepts the release tag where a version is expected: v0.75.2 means 0.75.2.
sumsName(String) - Static method in class flixw
The file name in one SHA256SUMS line.

T

T0 - Static variable in class flixw
 
table - Variable in record class flixw.LockField
The field for the table record component.
table - Variable in record class flixw.TomlEntry
The field for the table record component.
table() - Method in record class flixw.LockField
Returns the value of the table record component.
table() - Method in record class flixw.TomlEntry
Returns the value of the table record component.
tableJson(String, String) - Static method in class flixw
 
tables - Variable in record class flixw.TomlScan
The field for the tables record component.
tables() - Method in record class flixw.TomlScan
Returns the value of the tables record component.
tasksPath(Path) - Static method in class flixw
 
TESTED_CEILING - Static variable in class flixw
The interval flixw is tested on.
tokenize(String) - Static method in class flixw
One documented tokenizer: whitespace separates; '' and "" quote; \ escapes inside "" and bare.
TomlEntry(int, String, String, String, boolean) - Constructor for record class flixw.TomlEntry
Creates an instance of a TomlEntry record class.
tomlEscape(String) - Static method in class flixw
The two escapes a TOML basic string needs.
tomlLookup(String, String, String, String) - Static method in class flixw
Reads one key from one TOML table.
tomlScan(String, String) - Static method in class flixw
The single TOML line scanner in stage 0.
TomlScan(List<flixw.TomlEntry>, List<String>) - Constructor for record class flixw.TomlScan
Creates an instance of a TomlScan record class.
toString() - Method in record class flixw.Cached
Returns a string representation of this record class.
toString() - Method in record class flixw.EditorJarPref
Returns a string representation of this record class.
toString() - Method in record class flixw.Jvm
Returns a string representation of this record class.
toString() - Method in record class flixw.LocalCompiler
Returns a string representation of this record class.
toString() - Method in record class flixw.Lock
Returns a string representation of this record class.
toString() - Method in record class flixw.LockField
Returns a string representation of this record class.
toString() - Method in record class flixw.Pin
Returns a string representation of this record class.
toString() - Method in record class flixw.PinRecord
Returns a string representation of this record class.
toString() - Method in record class flixw.PluginDep
Returns a string representation of this record class.
toString() - Method in record class flixw.Refresh
Returns a string representation of this record class.
toString() - Method in record class flixw.ResolvedPlugin
Returns a string representation of this record class.
toString() - Method in record class flixw.TomlEntry
Returns a string representation of this record class.
toString() - Method in record class flixw.TomlScan
Returns a string representation of this record class.
tr(String) - Static method in class flixw
 
trace() - Static method in class flixw
 
triple(String) - Static method in class flixw
The `x.x.x` that `[package].flix` is allowed to hold.
tryEditorJarLink(Path, Path, boolean) - Static method in class flixw
Attempts a symlink or hard link; failure lets the caller try its fallback.

U

unknownLockKeys(String, String) - Static method in class flixw
Every key in the file that flixw.LOCK_SCHEMA does not describe, named the way a diagnostic names it, in file order and without repeats.
unquote(String) - Static method in class flixw
 
unquoteToml(String, String) - Static method in class flixw
A quoted TOML value, fully unescaped -- unlike flixw.unquote(java.lang.String), which every existing caller uses for a version, URL or digest, none of which can legally contain a backslash, so stripping the outer quotes has always been the whole job.
UNSAFE - Static variable in class flixw
 
updateWrapper(Path) - Static method in class flixw
doctor --fix: the asset rewrites the files it owns, stage 0 refreshes the lock, and the two counts are added up here.
upgradeWrapper(Path, String, boolean) - Static method in class flixw
Moves this project to the newest published flixw -- latest's pick, a version named outright, or, with pre, the newest release regardless of its own pre-release flag (see flixw.latestPrereleaseTag()).
UPSTREAM_REPO - Static variable in class flixw
Where the stock compiler comes from when nothing says otherwise.
url - Variable in record class flixw.Cached
The field for the url record component.
url - Variable in record class flixw.Lock
The field for the url record component.
url() - Method in record class flixw.Cached
Returns the value of the url record component.
url() - Method in record class flixw.Lock
Returns the value of the url record component.

V

VALIDATE_USAGE - Static variable in class flixw
 
validateDistUrl() - Static method in class flixw
Validated on every run, not only when a download happens: a warm cache would otherwise hide a malformed mirror setting until the day it is actually needed.
validateJavaPin(String, String) - Static method in class flixw
A pin is a dotted number and nothing else: no ranges, no `latest`, no vendor.
validateUrl(String, String) - Static method in class flixw
Structural validation, so a malformed lock produces a FLIXW diagnostic rather than an uncaught IllegalArgumentException from URI.create deep in the download path.
validateVersion(String, String) - Static method in class flixw
 
validPluginName(String) - Static method in class flixw
 
value - Variable in record class flixw.TomlEntry
The field for the value record component.
value() - Method in record class flixw.TomlEntry
Returns the value of the value record component.
verbIdentity(Path, flixw.Lock, boolean) - Static method in class flixw
Pinned compilers are identified by their locked digest; overrides by path+size+mtime.
verbs(Path, Path, String) - Static method in class flixw
 
verbsFile(Path, String) - Static method in class flixw
Verb records live in the wrapper cache keyed by identity, never beside the JAR: a content-addressed compiler directory is legitimately read-only, and a FLIX_JAR override points at a JAR flixw does not own and must not write next to.
version - Variable in record class flixw.Lock
The field for the version record component.
version - Variable in record class flixw.Pin
The field for the version record component.
version - Variable in record class flixw.PinRecord
The field for the version record component.
version - Variable in record class flixw.PluginDep
The field for the version record component.
version - Variable in record class flixw.ResolvedPlugin
The field for the version record component.
version() - Method in record class flixw.Lock
Returns the value of the version record component.
version() - Method in record class flixw.Pin
Returns the value of the version record component.
version() - Method in record class flixw.PinRecord
Returns the value of the version record component.
version() - Method in record class flixw.PluginDep
Returns the value of the version record component.
version() - Method in record class flixw.ResolvedPlugin
Returns the value of the version record component.
VERSION_TOKEN - Static variable in class flixw
A version token standing on its own, rather than one buried inside a longer word.

W

w001(String) - Static method in class flixw
 
w002(String) - Static method in class flixw
 
w003(String) - Static method in class flixw
 
w004(String) - Static method in class flixw
 
w005(String) - Static method in class flixw
 
w006(String) - Static method in class flixw
 
w007(String) - Static method in class flixw
 
w008(String) - Static method in class flixw
 
w009(String) - Static method in class flixw
 
w010(String) - Static method in class flixw
FLIXW010 and FLIXW011 are advisory: they are printed, they never set exit status.
w011(String) - Static method in class flixw
 
wantsHelp(List<String>) - Static method in class flixw
--help/-h anywhere in a wrapper verb's own arguments, the same way a user expects it to work on any CLI.
warmAssets(String, String) - Static method in class flixw
Fetches and verifies every companion asset of one release into the cache, so that the commands needing them work offline afterwards.
warnMissingJava(String) - Static method in class flixw
 
what - Variable in record class flixw.LockField
The field for the what record component.
what() - Method in record class flixw.LockField
Returns the value of the what record component.
why - Variable in record class flixw.Refresh
The field for the why record component.
why() - Method in record class flixw.Refresh
Returns the value of the why record component.
why(Exception) - Static method in class flixw
IOException.getMessage() is often bare the path; name the failure too.
WRAPPER_DIR - Static variable in class flixw
 
WRAPPER_VERBS - Static variable in class flixw
 
WRAPPER_VERSION - Static variable in class flixw
 
wrapperAnchor() - Static method in class flixw
Resolves this file's own symlink chain without physicalizing unrelated directories.
wrapperHelp() - Static method in class flixw
The last-resort help when the renderer itself cannot be reached.
wrapperNamespace(List<String>) - Static method in class flixw
flixw's own namespace.
wrapperUsage(String) - Static method in class flixw
 
wrapperVerb(String, List<String>, Path, flixw.Lock, Path, flixw.Jvm, List<String>, String) - Static method in class flixw
 
writeAtomic(Path, String) - Static method in class flixw
Same-directory temp plus an atomic move.
writeContextFile(Path, flixw.Lock, flixw.Jvm, Path, String, flixw.ResolvedPlugin, List<String>) - Static method in class flixw
The structured half of the ABI: everything flixw.pluginEnv(java.nio.file.Path, flixw.Lock, flixw.Jvm, java.nio.file.Path, java.lang.String, flixw.ResolvedPlugin, java.util.List<java.lang.String>)'s flat variables carry, plus the arguments this invocation was given, as one versioned JSON object.
writeEditorJarPref(Path, String, String) - Static method in class flixw
 
writeHelpRecord(String, String) - Static method in class flixw
Written on the one capture stage 0 already performs; a read-only cache stays silent.
writeLocalCompiler(Path, Path, String) - Static method in class flixw
 
writePinRecord(String, String, String) - Static method in class flixw
Written by pin itself, the moment it settles on a digest -- not deferred to the next flixw.acquire(flixw.Lock), which may never come: a project that pins one build and then immediately pins another runs no other command against the first digest in between, and a record only acquire writes would never see it.
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values