Packages

object Options extends OptionsPlatformSpecific

Linear Supertypes
OptionsPlatformSpecific, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Options
  2. OptionsPlatformSpecific
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Both[A, B](left: Options[A], right: Options[B]) extends Options[(A, B)] with Product with Serializable
  2. final case class KeyValueMap(argumentOption: Single[String]) extends Options[scala.Predef.Map[String, String]] with Product with Serializable
  3. final case class Map[A, B](value: Options[A], f: (A) => Either[ValidationError, B]) extends Options[B] with Product with Serializable
  4. final case class OAuth2Options(provider: OAuth2Provider, scope: List[String], auxiliaryOptions: Options[OAuth2AuxiliaryOptions]) extends Options[OAuth2Token] with Product with Serializable
  5. final case class OrElse[A, B](left: Options[A], right: Options[B]) extends Options[Either[A, B]] with Product with Serializable
  6. final case class Single[+A](name: String, aliases: Vector[String], primType: PrimType[A], description: HelpDoc = HelpDoc.Empty) extends Options[A] with Product with Serializable
  7. final case class WithDefault[A](options: Options[A], default: A) extends Options[A] with Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def boolean(name: String, ifPresent: Boolean, negationName: String, negationNames: String*): Options[Boolean]

    Creates a boolean flag with the specified name, which, if present, will produce the specified constant boolean value.

    Creates a boolean flag with the specified name, which, if present, will produce the specified constant boolean value. Negation names may be specified to explicitly invert the boolean value of this option.

  6. def boolean(name: String, ifPresent: Boolean = true): Options[Boolean]

    Creates a boolean flag with the specified name, which, if present, will produce the specified constant boolean value.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def decimal(name: String): Options[BigDecimal]

    Creates a parameter expecting a decimal number.

  9. def directory(name: String, exists: Exists = Exists.Either): Options[Path]

    Creates a parameter expecting path to the directory.

  10. def enumeration[A](name: String)(cases: (String, A)*): Options[A]

    Creates a parameter accepting one valye from set of allowed elements.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def file(name: String, exists: Exists = Exists.Either): Options[Path]

    Creates a parameter expecting path to the file.

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. def instant(name: String): Options[Instant]

    Creates a parameter expecting a parameter for instant in time in UTC format, such as 2007-12-03T10:15:30.00Z.

  17. def integer(name: String): Options[BigInt]

    Creates a parameter expecting an integer.

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def keyValueMap(argumentOption: Single[String]): Options[scala.Predef.Map[String, String]]

    Creates a property flag with from an argument option as Options.single.

  20. def keyValueMap(name: String): Options[scala.Predef.Map[String, String]]

    Creates a property flag with the specified name.

    Creates a property flag with the specified name. Property arguments may be repeated several times (-D key1=value -D key2=value) or specifying all key/values in one argument (-D key1=value key2=value).

  21. def localDate(name: String): Options[LocalDate]

    Creates a parameter excepting parameter for a date in ISO_LOCAL_DATE format, such as 2007-12-03.

  22. def localDateTime(name: String): Options[LocalDateTime]

    Creates a parameter excepting a date-time without a time-zone in the ISO-8601 format, such as 2007-12-03T10:15:30.

  23. def localTime(name: String): Options[LocalTime]

    Creates a parameter excepting a time without a time-zone in the ISO-8601 format, such as 10:15:30.

  24. def monthDay(name: String): Options[MonthDay]

    Creates a parameter excepting a month-day in the ISO-8601 format such as 12-03.

  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. val none: Options[Unit]
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  29. def oauth2(provider: OAuth2Provider, scope: List[String]): Options[OAuth2Token]

    Adds into the application OAuth2 authorization with the specified provider for permissions defined by scope.

    Adds into the application OAuth2 authorization with the specified provider for permissions defined by scope. The resulting zio.cli.oauth2.OAuth2Token will provide access token.

    Definition Classes
    OptionsPlatformSpecific
  30. def offsetDateTime(name: String): Options[OffsetDateTime]

    Creates a parameter excepting a date-time with an offset from UTC/Greenwich in the ISO-8601 format, such as 2007-12-03T10:15:30+01:00.

  31. def offsetTime(name: String): Options[OffsetTime]

    Creates a parameter excepting a time with an offset from UTC/Greenwich in the ISO-8601 format, such as 10:15:30+01:00.

  32. def period(name: String): Options[Period]

    Creates a parameter excepting a date-based amount of time in the ISO-8601 format, such as 'P1Y2M3D'.

  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def text(name: String): Options[String]

    Creates a parameter expecting an arbitrary text.

  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. def year(name: String): Options[Year]

    Creates a parameter expecting a year in the ISO-8601 format, such as 2007.

  40. def yearMonth(name: String): Options[YearMonth]

    Creates a parameter expecting a year-month in the ISO-8601 format, such as 2007-12..

  41. def zoneId(name: String): Options[ZoneId]

    Creates a parameter expecting a time-zone ID, such as Europe/Paris.

  42. def zoneOffset(name: String): Options[ZoneOffset]

    Creates a parameter expecting a time-zone offset from Greenwich/UTC, such as +02:00.

  43. def zonedDateTime(name: String): Options[ZonedDateTime]

    Creates a date-time with a time-zone in the ISO-8601 format, such as 2007-12-03T10:15:30+01:00 Europe/Paris.

  44. case object Empty extends Options[Unit] with Product with Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from OptionsPlatformSpecific

Inherited from AnyRef

Inherited from Any

Ungrouped