Package software.amazon.smithy.docgen

Record Class DocFormat

java.lang.Object

java.lang.Record

software.amazon.smithy.docgen.DocFormat

Record Components:

name - The name of the format. This will be the string that will be set as the value of format in DocSettings.

extension - The file extension to use by default for documentation files. This will be set on the Symbols automatically by DocSymbolProvider.FileExtensionDecorator.

writerFactory - A factory method for creating writers that write in this format.

public record DocFormat(String name, String extension, SymbolWriter.Factory<DocWriter> writerFactory)
extends Record

A record containing information about a doc format.

Use DocIntegration.docFormats(software.amazon.smithy.docgen.DocSettings) to make new formats available.

Constructor Summary

Constructors

Constructor	Description
DocFormat(String name, String extension, SymbolWriter.Factory<DocWriter> writerFactory)	Creates an instance of a DocFormat record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	extension()	Returns the value of the extension record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
SymbolWriter.Factory<DocWriter>	writerFactory()	Returns the value of the writerFactory record component.

Methods inherited from class java.lang.Object

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

Constructor Details

DocFormat

public DocFormat(String name,
 String extension,
 SymbolWriter.Factory<DocWriter> writerFactory)

Creates an instance of a DocFormat record class.

Parameters:

name - the value for the name record component

extension - the value for the extension record component

writerFactory - the value for the writerFactory 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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

extension

public String extension()

Returns the value of the extension record component.

Returns:

the value of the extension record component

writerFactory

public SymbolWriter.Factory<DocWriter> writerFactory()

Returns the value of the writerFactory record component.

Returns:

the value of the writerFactory record component