Package software.amazon.smithy.docgen.sections.sphinx

Record Class IndexSection

java.lang.Object

java.lang.Record

software.amazon.smithy.docgen.sections.sphinx.IndexSection

Record Components:

context - The context used to generate documentation.

directory - The directory the index covers.

sourceFiles - The sphinx source files contained in the directory that need to be present in generated toctrees.

All Implemented Interfaces:

CodeSection

public record IndexSection(DocGenerationContext context, Path directory, Set<Path> sourceFiles)
extends Record
implements CodeSection

Contains index files for sphinx.

These indexes are necessary to build up the left-side navigation bar.

Constructor Summary

Constructors

Constructor	Description
IndexSection(DocGenerationContext context, Path directory, Set<Path> sourceFiles)	Creates an instance of a IndexSection record class.

Method Summary

Modifier and Type	Method	Description
DocGenerationContext	context()	Returns the value of the context record component.
Path	directory()	Returns the value of the directory record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Set<Path>	sourceFiles()	Returns the value of the sourceFiles record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.smithy.utils.CodeSection

sectionName

Constructor Details

IndexSection

public IndexSection(DocGenerationContext context,
 Path directory,
 Set<Path> sourceFiles)

Creates an instance of a IndexSection record class.

Parameters:

context - the value for the context record component

directory - the value for the directory record component

sourceFiles - the value for the sourceFiles record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

context

public DocGenerationContext context()

Returns the value of the context record component.

Returns:

the value of the context record component

directory

public Path directory()

Returns the value of the directory record component.

Returns:

the value of the directory record component

sourceFiles

public Set<Path> sourceFiles()

Returns the value of the sourceFiles record component.

Returns:

the value of the sourceFiles record component