Packages

sealed trait LengthLimitedString extends AbstractLengthLimitedString

This trait wraps a String that is limited to a certain maximum length. Classes implementing this trait expose create and tryCreate methods to safely (and non-safely) construct such a String.

The canonical use case for LengthLimitedStrings is ensuring that we don't write too long strings into the database. This validation generally occurs on the server side and not on the client side. Concretely, this means that the Admin API and Ledger API gRPC services is the point where we validate that the received Protobuf Strings are not too long (and convert them into LengthLimitedStrings). On the client side, e.g. at the console, we generally take normal String types.

For longer strings, directly inherit from AbstractLengthLimitedString.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LengthLimitedString
  2. AbstractLengthLimitedString
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def maxLength: PositiveInt

    Maximum number of characters allowed.

    Maximum number of characters allowed.

    Must not be confused with storage space, which can be up to 4*maxLength in a UTF8 encoding

    Definition Classes
    AbstractLengthLimitedString
  2. abstract def str: String
    Attributes
    protected
    Definition Classes
    AbstractLengthLimitedString

Concrete 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 canEqual(a: Any): Boolean
    Definition Classes
    AbstractLengthLimitedString
    Annotations
    @SuppressWarnings()
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(that: Any): Boolean
    Definition Classes
    AbstractLengthLimitedString → AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AbstractLengthLimitedString → AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def name: Option[String]
    Attributes
    protected
    Definition Classes
    AbstractLengthLimitedString
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def nonEmpty: Boolean
    Definition Classes
    AbstractLengthLimitedString
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toProtoPrimitive: String
    Definition Classes
    AbstractLengthLimitedString
  19. def toString(): String
    Definition Classes
    AbstractLengthLimitedString → AnyRef → Any
  20. def tryConcatenate(that: String): LengthLimitedStringVar
  21. def tryConcatenate(that: LengthLimitedString): LengthLimitedStringVar
  22. def unwrap: String
    Definition Classes
    AbstractLengthLimitedString
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped