Module aya.cli.impl

Package org.aya.cli.render

Class RenderOptions

java.lang.Object

org.aya.cli.render.RenderOptions

public class RenderOptions
extends Object

Multi-target Stylist, usually created from json files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RenderOptions.ColorSchemeName
static final record	RenderOptions.Opts
static enum	RenderOptions.OutputTarget
static enum	RenderOptions.StyleFamilyName

Field Summary

Fields

Modifier and Type	Field	Description
@UnknownNullability RenderOptions.ColorSchemeName	colorScheme
static final @NotNull RenderOptions.ColorSchemeName	DEFAULT_COLOR_SCHEME
static final @NotNull RenderOptions.StyleFamilyName	DEFAULT_STYLE_FAMILY
@Nullable String	path
@UnknownNullability RenderOptions.StyleFamilyName	styleFamily

Constructor Summary

Constructors

Constructor	Description
RenderOptions()

Method Summary

Modifier and Type	Method	Description
void	checkDeserialization()
static @NotNull org.aya.pretty.backend.string.StringStylist	defaultStylist(@NotNull RenderOptions.OutputTarget output)
boolean	equals(Object o)
void	invalidate()
boolean	isDefault()
@NotNull String	prettyColorScheme()
@NotNull String	prettyStyleFamily()
@NotNull String	render(@NotNull RenderOptions.OutputTarget output, @NotNull org.aya.pretty.doc.Doc doc, @NotNull RenderOptions.Opts opts)
@NotNull org.aya.pretty.backend.string.StringStylist	stylist(@NotNull RenderOptions.OutputTarget output)
@NotNull org.aya.pretty.backend.string.StringStylist	stylistOrDefault(@NotNull RenderOptions.OutputTarget output)
void	updateColorScheme(@NotNull kala.control.Either<RenderOptions.ColorSchemeName,Path> nameOrPath)
void	updateStyleFamily(@NotNull kala.control.Either<RenderOptions.StyleFamilyName,Path> nameOrPath)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_COLOR_SCHEME

@NotNull
public static final @NotNull RenderOptions.ColorSchemeName DEFAULT_COLOR_SCHEME

DEFAULT_STYLE_FAMILY

@NotNull
public static final @NotNull RenderOptions.StyleFamilyName DEFAULT_STYLE_FAMILY

colorScheme

public @UnknownNullability RenderOptions.ColorSchemeName colorScheme

styleFamily

public @UnknownNullability RenderOptions.StyleFamilyName styleFamily

path

@Nullable
public @Nullable String path

Constructor Details

RenderOptions

public RenderOptions()

Method Details

checkDeserialization

public void checkDeserialization()

isDefault

public boolean isDefault()

prettyColorScheme

@NotNull
public @NotNull String prettyColorScheme()

prettyStyleFamily

@NotNull
public @NotNull String prettyStyleFamily()

updateColorScheme

public void updateColorScheme(@NotNull
 @NotNull kala.control.Either<RenderOptions.ColorSchemeName,Path> nameOrPath)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

updateStyleFamily

public void updateStyleFamily(@NotNull
 @NotNull kala.control.Either<RenderOptions.StyleFamilyName,Path> nameOrPath)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

invalidate

public void invalidate()

defaultStylist

@NotNull
public static @NotNull org.aya.pretty.backend.string.StringStylist defaultStylist(@NotNull
 @NotNull RenderOptions.OutputTarget output)

stylist

@NotNull
public @NotNull org.aya.pretty.backend.string.StringStylist stylist(@NotNull
 @NotNull RenderOptions.OutputTarget output)
                                                             throws IOException,
com.google.gson.JsonParseException

Throws:

IOException

com.google.gson.JsonParseException

stylistOrDefault

@NotNull
public @NotNull org.aya.pretty.backend.string.StringStylist stylistOrDefault(@NotNull
 @NotNull RenderOptions.OutputTarget output)

render

@NotNull
public @NotNull String render(@NotNull
 @NotNull RenderOptions.OutputTarget output,
 @NotNull
 @NotNull org.aya.pretty.doc.Doc doc,
 @NotNull
 @NotNull RenderOptions.Opts opts)

equals

public boolean equals(Object o)

Overrides:

equals in class Object