Module aya.base

Package org.aya.concrete.remark

Class Literate.CodeBlock

java.lang.Object

org.aya.concrete.remark.Literate.CodeBlock

All Implemented Interfaces:

Literate, org.aya.pretty.doc.Docile

Enclosing interface:

Literate

public static final class Literate.CodeBlock
extends Object
implements Literate

A code block

Implementation Note:

the content which this code block hold can be illegal, like

 ```aya

 def foo : Nat =>
 ```

 

Nested Class Summary

Nested classes/interfaces inherited from interface org.aya.concrete.remark.Literate

Literate.Code, Literate.CodeBlock, Literate.Err, Literate.Link, Literate.Many, Literate.Raw, Literate.Unsupported

Field Summary

Fields

Modifier and Type	Field	Description
@Nullable org.aya.pretty.doc.Doc	highlighted
final @NotNull String	language
final @NotNull String	raw
final @Nullable org.aya.util.error.SourcePos	sourcePos	The source pos of the code block ( without beginning '```', and ending '\n```' ) null if this code block is empty (length 0)

Constructor Summary

Constructors

Constructor	Description
CodeBlock(@Nullable org.aya.util.error.SourcePos sourcePos, @NotNull String language, @NotNull String raw)

Method Summary

Modifier and Type	Method	Description
boolean	isAya()
@NotNull org.aya.pretty.doc.Doc	toDoc()

Methods inherited from class java.lang.Object

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

Field Details

language

@NotNull
public final @NotNull String language

raw

@NotNull
public final @NotNull String raw

highlighted

@Nullable
public @Nullable org.aya.pretty.doc.Doc highlighted

sourcePos

@Nullable
public final @Nullable org.aya.util.error.SourcePos sourcePos

The source pos of the code block ( without beginning '```', and ending '\n```' ) null if this code block is empty (length 0)

Constructor Details

CodeBlock

public CodeBlock(@Nullable
 @Nullable org.aya.util.error.SourcePos sourcePos,
 @NotNull
 @NotNull String language,
 @NotNull
 @NotNull String raw)

Method Details

isAya

public boolean isAya()

toDoc

@NotNull
public @NotNull org.aya.pretty.doc.Doc toDoc()

Specified by:

toDoc in interface org.aya.pretty.doc.Docile