Package org.projectnessie.model

Interface Documentation

@Immutable
public interface Documentation

Represents documentation for a content object in Nessie.

Method Summary

Modifier and Type	Method	Description
static org.projectnessie.model.ImmutableDocumentation.Builder	builder()
@NotNull @NotNull String	getMimeType()	Mime type of the documentation.
@NotNull @NotNull String	getText()	Documentation text, format according to getMimeType().
static Documentation	of(String mimeType, String text)

Method Details

builder

static org.projectnessie.model.ImmutableDocumentation.Builder builder()

getMimeType

@NotNull
@NotNull
@Parameter(order=1)
@NotNull @NotNull String getMimeType()

Mime type of the documentation.

Clients must interpret this value and must not assume a specific mime type.

getText

@NotNull
@NotNull
@Parameter(order=2)
@NotNull @NotNull String getText()

Documentation text, format according to getMimeType().

of

static Documentation of(String mimeType,
 String text)