org.apache.pekko.http.scaladsl.model

Class HttpCharset

java.lang.Object

org.apache.pekko.http.javadsl.model.HttpCharset

org.apache.pekko.http.scaladsl.model.HttpCharset

All Implemented Interfaces:

java.io.Serializable, Renderable, SingletonValueRenderable, WithQValue<HttpCharsetRange>, scala.Equals, scala.Product

public final class HttpCharset
extends HttpCharset
implements SingletonValueRenderable, WithQValue<HttpCharsetRange>, scala.Product, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HttpCharset(java.lang.String value, scala.collection.immutable.Seq<java.lang.String> aliases)

Method Summary

Modifier and Type	Method and Description
scala.collection.immutable.Seq<java.lang.String>	aliases()
HttpCharset	charsetWithUtf8Failover()
static HttpCharset	custom(java.lang.String value, scala.collection.immutable.Seq<java.lang.String> aliases)
static scala.util.Try<java.nio.charset.Charset>	findNioCharset(java.lang.String name)
java.lang.Iterable<java.lang.String>	getAliases() Java API
java.nio.charset.Charset	nioCharset() Returns the Charset for this charset if available or throws an exception otherwise
HttpCharsetRange	toRange() Creates a range from this charset with qValue = 1.
java.lang.String	value() Returns the name of this charset.
HttpCharsetRange	withQValue(float qValue) An alias for toRange(float).

Methods inherited from class org.apache.pekko.http.javadsl.model.HttpCharset

toRange

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pekko.http.impl.util.SingletonValueRenderable

render

Methods inherited from interface scala.Product

$init$, productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface org.apache.pekko.http.scaladsl.model.WithQValue

withQValue

Constructor Detail

HttpCharset

public HttpCharset(java.lang.String value,
                   scala.collection.immutable.Seq<java.lang.String> aliases)

Method Detail

custom

public static HttpCharset custom(java.lang.String value,
                                 scala.collection.immutable.Seq<java.lang.String> aliases)

findNioCharset

public static scala.util.Try<java.nio.charset.Charset> findNioCharset(java.lang.String name)

value

public java.lang.String value()

Description copied from class: HttpCharset

Returns the name of this charset.

Specified by:

value in interface SingletonValueRenderable

Specified by:

value in class HttpCharset

aliases

public scala.collection.immutable.Seq<java.lang.String> aliases()

nioCharset

public java.nio.charset.Charset nioCharset()

Returns the Charset for this charset if available or throws an exception otherwise

Specified by:

nioCharset in class HttpCharset

charsetWithUtf8Failover

public HttpCharset charsetWithUtf8Failover()

Returns:

this HttpCharset instance if this charset can be parsed to a java.nio.charset.Charset instance, otherwise returns the UTF-8 charset.

Since:

1.1.0

withQValue

public HttpCharsetRange withQValue(float qValue)

Description copied from class: HttpCharset

An alias for toRange(float).

Specified by:

withQValue in interface WithQValue<HttpCharsetRange>

Specified by:

withQValue in class HttpCharset

toRange

public HttpCharsetRange toRange()

Description copied from class: HttpCharset

Creates a range from this charset with qValue = 1.

Overrides:

toRange in class HttpCharset

getAliases

public java.lang.Iterable<java.lang.String> getAliases()

Java API

Specified by:

getAliases in class HttpCharset