implicit final class EnumOps[A] extends JsonSchemaDocumentationOps[A]
- Alphabetic
- By Inheritance
- EnumOps
- JsonSchemaDocumentationOps
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
type
Self = Enum[A]
- Definition Classes
- EnumOps → JsonSchemaDocumentationOps
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
named(name: String): Enum[A]
Give a name to the schema
Give a name to the schema
- Encoder and decoder interpreters ignore the name,
- Documentation interpreters use that name to refer to this schema.
- Note
Names are used by documentation interpreters to construct references and the JSON schema specification requires these to be valid URI's. Consider using
withTitle
if you just want to override the heading displayed in documentation.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withDescription(description: String): Enum[A]
Include a description of what this schema represents
Include a description of what this schema represents
- Encoder and decoder interpreters ignore this description,
- Documentation interpreters can show this description.
- description
information about the values described by the schema
- Definition Classes
- EnumOps → JsonSchemaDocumentationOps
-
def
withExample(example: A): Enum[A]
Include an example of value in this schema
Include an example of value in this schema
- Encoder and decoder interpreters ignore this value,
- Documentation interpreters can show this example value.
- example
Example value to attach to the schema
- Definition Classes
- EnumOps → JsonSchemaDocumentationOps
-
def
withTitle(title: String): Enum[A]
Include a title for the schema
Include a title for the schema
- Encoder and decoder interpreters ignore the title,
- Documentation interpreters can show this title.
- title
short title to attach to the schema
- Definition Classes
- EnumOps → JsonSchemaDocumentationOps