Module dev.hydraulic.types

Package dev.hydraulic.types.mimetyped

Class MimeTypedString<M extends MimeType>

java.lang.Object

dev.hydraulic.types.mimetyped.MimeTypedString<M>

Type Parameters:

M - A marker type that isn't represented or stored at runtime. It exists only for source documentation, type inference, reflection and languages that have extension functions. So, feel free to use a wildcard type here, you won't lose anything except some type safety.

All Implemented Interfaces:

MimeTyped<String,M>, Serializable, CharSequence, Comparable<MimeTypedString<M>>

public final class MimeTypedString<M extends MimeType>
extends Object
implements CharSequence, Serializable, Comparable<MimeTypedString<M>>, MimeTyped<String,M>

A value-based type that combines a string with an associated MIME type. The class implements CharSequence by delegation, thus can be treated as if it were the underlying string in some cases. Two instances are compared using MIME_TYPE_THEN_CONTENT.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Comparator<MimeTypedString<?>>	MIME_TYPE_THEN_CONTENT	A comparator that sorts first by mime type, and then by content.

Constructor Summary

Constructors

Constructor	Description
MimeTypedString(String content, String mimeType)	Constructs an immutable mime-typed string.

Method Summary

Modifier and Type	Method	Description
char	charAt(int index)
@NotNull IntStream	chars()
@NotNull IntStream	codePoints()
int	compareTo(@NotNull MimeTypedString o)
String	content()	The wrapped content.
static MimeTypedString<MimeType.text.csv>	csv(String csv)	text/csv
boolean	equals(Object o)
int	hashCode()
static MimeTypedString<MimeType.text.html>	html(String html)	text/html
static MimeTypedString<MimeType.text.json>	json(String json)	application/json
int	length()
static MimeTypedString<MimeType.text.markdown>	markdown(String text)	text/markdown
String	mimeType()	The MIME type.
static MimeTypedString<MimeType.text.plain>	plain(String text)	text/plain
@NotNull CharSequence	subSequence(int start, int end)
static MimeTypedString<MimeType.text>	text(String subtype, String text)	Returns the text as text/subtype.
String	toString()	Returns content.
static MimeTypedString<MimeType.application.xml>	xml(String xml)	application/xml

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

isEmpty

Field Details

MIME_TYPE_THEN_CONTENT

public static Comparator<MimeTypedString<?>> MIME_TYPE_THEN_CONTENT

A comparator that sorts first by mime type, and then by content.

Constructor Details

MimeTypedString

public MimeTypedString(String content,
 String mimeType)

Constructs an immutable mime-typed string.

Parameters:

content - The wrapped string.

mimeType - A MIME type.

Method Details

text

public static MimeTypedString<MimeType.text> text(String subtype,
 String text)

Returns the text as text/subtype.

plain

public static MimeTypedString<MimeType.text.plain> plain(String text)

text/plain

xml

public static MimeTypedString<MimeType.application.xml> xml(String xml)

application/xml

json

public static MimeTypedString<MimeType.text.json> json(String json)

application/json

html

public static MimeTypedString<MimeType.text.html> html(String html)

text/html

csv

public static MimeTypedString<MimeType.text.csv> csv(String csv)

text/csv

markdown

public static MimeTypedString<MimeType.text.markdown> markdown(String text)

text/markdown

content

public String content()

The wrapped content.

Specified by:

content in interface MimeTyped<String,M extends MimeType>

mimeType

public String mimeType()

The MIME type.

Specified by:

mimeType in interface MimeTyped<String,M extends MimeType>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns content.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

@NotNull
public @NotNull CharSequence subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

chars

@NotNull
public @NotNull IntStream chars()

Specified by:

chars in interface CharSequence

codePoints

@NotNull
public @NotNull IntStream codePoints()

Specified by:

codePoints in interface CharSequence

compareTo

public int compareTo(@NotNull
 @NotNull MimeTypedString o)

Specified by:

compareTo in interface Comparable<M extends MimeType>