Skip to content

Commit

Permalink
Implement MediaType structured syntax suffix
Browse files Browse the repository at this point in the history
  • Loading branch information
@mizosoft
mizosoft committed Dec 20, 2024
1 parent c298105 commit 60e69c8
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 26 deletions.
40 changes: 17 additions & 23 deletions methanol/src/main/java/com/github/mizosoft/methanol/MediaType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,6 @@ public Optional<Charset> charset() {
* Returns either the value of the charset parameter or the given default charset if no such
* parameter exists or if the charset has no support in this JVM.
*
* @param defaultCharset the charset to fall back to
* @throws IllegalCharsetNameException if a charset parameter exists the value of which is invalid
*/
public Charset charsetOrDefault(Charset defaultCharset) {
Expand All @@ -199,13 +198,16 @@ public Charset charsetOrDefault(Charset defaultCharset) {
}
}

/** Equivalent to calling {@link #charsetOrDefault(Charset) charsetOrDefault(StandardCharsets.UTF_8)}. */
/**
* Equivalent to calling {@link #charsetOrDefault(Charset)
* charsetOrDefault(StandardCharsets.UTF_8)}.
*/
public Charset charsetOrUtf8() {
return charsetOrDefault(UTF_8);
}

/**
* Return {@code true} if this media type is {@code *}{@code /*} or if it has a wildcard subtype.
* Returns {@code true} if this media type is {@code *}{@code /*} or if it has a wildcard subtype.
*/
public boolean hasWildcard() {
return type.equals(WILDCARD) || subtype.equals(WILDCARD);
Expand All @@ -216,24 +218,27 @@ public boolean hasWildcard() {
* former's parameters is a subset of the latter's and either the former is a {@link
* #hasWildcard() wildcard type} that includes the latter or both have equal concrete type and
* subtype.
*
* @param other the other media type
*/
public boolean includes(MediaType other) {
return includesType(other.type, other.subtype)
return includes(other.type, other.subtype)
&& other.parameters.entrySet().containsAll(parameters.entrySet());
}

private boolean includesType(String otherType, String otherSubtype) {
return type.equals(WILDCARD)
|| (type.equals(otherType) && (subtype.equals(WILDCARD) || subtype.equals(otherSubtype)));
private boolean includes(String otherType, String otherSubtype) {
return type.equals(WILDCARD) || (type.equals(otherType) && includesSubtype(otherSubtype));
}

private boolean includesSubtype(String otherSubtype) {
int structuredSuffixIndex;
return subtype.equals(WILDCARD)
|| subtype.equals(otherSubtype)
|| ((structuredSuffixIndex = otherSubtype.lastIndexOf('+')) != -1
&& otherSubtype.regionMatches(structuredSuffixIndex + 1, subtype, 0, subtype.length()));
}

/**
* Returns whether this media type is compatible with the given one. Two media types are
* compatible if either of them {@link #includes(MediaType) includes} the other.
*
* @param other the other media type
*/
public boolean isCompatibleWith(MediaType other) {
return this.includes(other) || other.includes(this);
Expand All @@ -242,8 +247,6 @@ public boolean isCompatibleWith(MediaType other) {
/**
* Returns a new {@code MediaType} with this instance's type, subtype and parameters but with the
* name of the given charset as the value of the charset parameter.
*
* @param charset the new type's charset
*/
public MediaType withCharset(Charset charset) {
requireNonNull(charset);
Expand All @@ -257,8 +260,6 @@ public MediaType withCharset(Charset charset) {
* Returns a new {@code MediaType} with this instance's type, subtype and parameters but with the
* value of the parameter specified by the given name set to the given value.
*
* @param name the parameter's name
* @param value the parameter's value
* @throws IllegalArgumentException if the given name or value is invalid
*/
public MediaType withParameter(String name, String value) {
Expand All @@ -269,7 +270,6 @@ public MediaType withParameter(String name, String value) {
* Returns a new {@code MediaType} with this instance's type, subtype and parameters but with each
* of the given parameters' names set to their corresponding values.
*
* @param parameters the parameters to add or replace
* @throws IllegalArgumentException if any of the given parameters is invalid
*/
public MediaType withParameters(Map<String, String> parameters) {
Expand All @@ -278,7 +278,7 @@ public MediaType withParameters(Map<String, String> parameters) {

/**
* Tests the given object for equality with this instance. {@code true} is returned if the given
* object is a {@code MediaType} and both instances's type, subtype and parameters are equal.
* object is a {@code MediaType} and both instances' type, subtype and parameters are equal.
*
* @param obj the object to test for equality
*/
Expand Down Expand Up @@ -328,8 +328,6 @@ private String computeToString() {
/**
* Returns a new {@code MediaType} with the given type and subtype.
*
* @param type the general type
* @param subtype the subtype
* @throws IllegalArgumentException if the given type or subtype is invalid
*/
public static MediaType of(String type, String subtype) {
Expand All @@ -339,9 +337,6 @@ public static MediaType of(String type, String subtype) {
/**
* Returns a new {@code MediaType} with the given type, subtype and parameters.
*
* @param type the general type
* @param subtype the subtype
* @param parameters the parameters
* @throws IllegalArgumentException if the given type, subtype or any of the given parameters is
* invalid
*/
Expand Down Expand Up @@ -387,7 +382,6 @@ private static String validateAndNormalizeToken(String token) {
/**
* Parses the given string into a {@code MediaType} instance.
*
* @param value the media type string
* @throws IllegalArgumentException if the given string is an invalid media type
*/
public static MediaType parse(String value) {
Expand Down
27 changes: 24 additions & 3 deletions methanol/src/test/java/com/github/mizosoft/methanol/MediaTypeTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,9 +263,9 @@ void parseEmptyQuotedValue() {
void parseQuotedValueWithQuotedPairs() {
var escapedValue = "\\\"\\\\\\a"; // \"\\\a unescaped to -> "\a
var unescapedValue = "\"\\a"; // "\a
var reespacedValue = "\\\"\\\\a"; // \"\\a (only backslash and quotes are re-quoted)
var reEscapedValue = "\\\"\\\\a"; // \"\\a (only backslash and quotes are re-quoted)
assertThat(MediaType.parse("text/plain; a=\"" + escapedValue + "\""))
.hasToString("text/plain; a=\"" + reespacedValue + "\"")
.hasToString("text/plain; a=\"" + reEscapedValue + "\"")
.extracting(MediaType::parameters, MAP)
.containsExactly(entry("a", unescapedValue));
}
Expand Down Expand Up @@ -360,6 +360,27 @@ void inclusion() {
assertThat(MediaType.parse("text/plain").includes(MediaType.parse("text/*"))).isFalse();
}

@Test
void inclusionWithStructuredSyntaxSuffix() {
assertInclusion(MediaType.parse("application/json"), MediaType.parse("application/x+json"));
assertInclusion(
MediaType.parse("application/json"), MediaType.parse("application/vnd.me+json"));
assertThat(
MediaType.parse("application/vnd.me+json")
.includes(MediaType.parse("application/json")))
.isFalse();
assertThat(
MediaType.parse("application/json").includes(MediaType.parse("application/vnd.me+xml")))
.isFalse();
assertThat(
MediaType.parse("application/vnd.me+xml").includes(MediaType.parse("application/json")))
.isFalse();
assertThat(MediaType.parse("application/json").includes(MediaType.parse("application/+")))
.isFalse();
assertThat(MediaType.parse("application/+").includes(MediaType.parse("application/json")))
.isFalse();
}

@Test
void equalsAndHashcode() {
assertThat(MediaType.parse("text/plain; charset=utf-8; a=pikachu"))
Expand All @@ -379,7 +400,7 @@ void equalsAndHashcode() {
Map.of(
"a", "pikachu",
"charset", "utf-8")));
assertThat(MediaType.parse("text/plain").equals("text/plain")).isFalse();
assertThat(MediaType.parse("text/plain")).isNotEqualTo("text/plain");
}

// Exceptional behaviour
Expand Down

0 comments on commit 60e69c8

Please sign in to comment.