@haxall/haxall
    Preparing search index...

    Class XetoCmd

    Xeto CLI command plugin. To create:

    1. Define subclass of XetoCmd
    2. Register type qname via indexed prop as "xeto.cmd" (if not in this pod)
    3. Annotate options and args using util::AbstractMain design

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Command name alises/shortcuts

      Returns List<string>

    • App name is "xeto {name}"

      Returns string

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Print error message and return 1

      Parameters

      • msg: string

      Returns number

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Print usage help.

      Returns boolean

    • Print usage help.

      Parameters

      • it: boolean

      Returns void

    • Home directory for the application. For a script this defaults to directory of the script. For pods the default is "{Env.cur.workDir}/etc/{pod}".

      Returns File

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Log name is "xeto"

      Returns Log

    • Main performs the following tasks:

      1. Calls parseArgs to parse command line
      2. If args were incomplete or -help was specified then dump usage and return 1
      3. Call run and return 0
      4. If an exception is raised log it and return 1

      Parameters

      • Optionalargs: List<string>

      Returns number

    • Command name

      Returns string

    • Name and aliases

      Returns List<string>

    • Parse the command line and set this instances fields. Return false if not all of the arguments were passed.

      Parameters

      Returns boolean

    • Print a line to stdout

      Parameters

      • Optionalline: string

      Returns void

    • Prompt for a confirm yes/no

      Parameters

      • msg: string

      Returns boolean

    • Read an input file of dicts from any format

      Parameters

      Returns List<Dict>

    • Run the command. Return zero on success

      Returns number

    • Run the set of services:

      1. call install on each service
      2. call start on each service
      3. put main thread to sleep.
      4. on shutodwn call stop on each service
      5. then call uninstall on each service

      Parameters

      Returns number

    • Single line summary of the command for help

      Returns string

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • Print usage of arguments and options. Return non-zero.

      Parameters

      Returns number

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Output to a file or stdout and guaranteed closed

      Parameters

      Returns void

    • Output grid to given file extension

      Parameters

      Returns void

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Find a specific command or return null

      Parameters

      • name: string

      Returns XetoCmd

    • List installed commands

      Returns List<XetoCmd>

    • Parameters

      • ...args: unknown[]

      Returns XetoCmd

    • Print a map of key/value pairs to output with values justified. Values that are lists are indented and separated by newlines. Options:

      • out: OutStream to print to (default is Env.cur.out)
      • indent: Str spaces (default is "")

      Parameters

      Returns void

    • Get map of the standard runtime props including:

      • java version info if JVM
      • node version if running in NodeJS
      • fan version Map vals are Strs or Lists to indent. Also see printProps

      Parameters

      Returns Map<string, JsObj>