com.upokecenter.mail.MediaTypeBuilder

# com.upokecenter.mail.MediaTypeBuilder

@Deprecated public final class MediaTypeBuilder extends Object

A mutable media type object.

Constructors

Methods

• final String getSubType()
  Deprecated. Gets this value’s subtype.

• final String getTopLevelType()
  Deprecated. Gets this value’s top-level type.

• final boolean isMultipart()
  Deprecated. Instead of using this property, use the TopLevelType property and compare the result with the exact String ‘multipart’.

• final boolean isText()
  Deprecated. Instead of using this property, use the TopLevelType property and compare the result with the exact String ‘text’.

• MediaTypeBuilder RemoveParameter(String name)
  Deprecated. Removes a parameter from this builder object.

• MediaTypeBuilder SetParameter(String name, String value)
  Deprecated. Sets a parameter’s name and value for this media type.

• final void setSubType(String value)
  Deprecated.  

• MediaTypeBuilder SetSubType(String str)
  Deprecated. Sets this media type’s subtype, such as “plain” or “xml” .

• final void setTopLevelType(String value)
  Deprecated.  

• MediaTypeBuilder SetTopLevelType(String str)
  Deprecated. Sets this media type’s top-level type.

• MediaType ToMediaType()
  Deprecated. Converts this builder to an immutable media type object.

• String toString()
  Deprecated. Converts this object to a text string of the media type it represents, in the same form as MediaType.toString.

Method Details

getTopLevelType

public final String getTopLevelType()

Gets this value’s top-level type.

Returns:

• A text string naming this object’s top-level type, such as “text” or “audio” .

Throws:

• NullPointerException - The property is being set and the value is null.

• IllegalArgumentException - The property is being set and the value is syntactically invalid for a top-level type.

setTopLevelType

public final void setTopLevelType(String value)

getSubType

public final String getSubType()

Gets this value’s subtype.

Returns:

• A text string naming this object’s subtype, such as “plain” or “xml”.

Throws:

• NullPointerException - The property is being set and the value is null.

• IllegalArgumentException - The property is being set and the value is syntactically invalid for a subtype.

setSubType

public final void setSubType(String value)

isText

@Deprecated public final boolean isText()

Gets a value indicating whether this is a text media type.

Returns:

• true If this is a text media type; otherwise, false.

isMultipart

@Deprecated public final boolean isMultipart()

Gets a value indicating whether this is a multipart media type.

Returns:

• true If this is a multipart media type; otherwise, false.

ToMediaType

public MediaType ToMediaType()

Converts this builder to an immutable media type object.

Returns:

• A MediaType object.

SetTopLevelType

public MediaTypeBuilder SetTopLevelType(String str)

Sets this media type’s top-level type. This method enables the pattern of method chaining (for example, new...().getSet()...().getSet()...()) unlike with the TopLevelType property in.NET or the setTopLevelType method (with small s) in Java.

Parameters:

• str - A text string naming a top-level type, such as “text” or “audio” .

Returns:

• This instance.

Throws:

• NullPointerException - The parameter str is null.

• IllegalArgumentException - The parameter str is syntactically invalid for a top-level type.

RemoveParameter

public MediaTypeBuilder RemoveParameter(String name)

Removes a parameter from this builder object. Does nothing if the parameter’s name doesn’t exist.

Parameters:

• name - Name of the parameter to remove. The name is compared using a basic case-insensitive comparison. (Two strings are equal in such a comparison, if they match after converting the basic uppercase letters A to Z (U+0041 to U+005A) in both strings to basic lowercase letters.).

Returns:

• This instance.

Throws:

• NullPointerException - The parameter name is null.

SetParameter

public MediaTypeBuilder SetParameter(String name, String value)

Sets a parameter’s name and value for this media type.

Parameters:

• name - Name of the parameter to set, such as “charset” . The name is compared using a basic case-insensitive comparison. (Two strings are equal in such a comparison, if they match after converting the basic uppercase letters A to Z (U+0041 to U+005A) in both strings to basic lowercase letters.).

• value - A text string giving the parameter’s value.

Returns:

• This instance.

Throws:

• NullPointerException - The parameter value or name is null.

• IllegalArgumentException - The parameter name is empty or syntactically invalid.

SetSubType

public MediaTypeBuilder SetSubType(String str)

Sets this media type’s subtype, such as “plain” or “xml” . This method enables the pattern of method chaining (for example, new...().getSet()...().getSet()...()) unlike with the SubType property in.NET or the setSubType method (with small s) in Java.

Parameters:

• str - A text string naming a media subtype.

Returns:

• This instance.

Throws:

• NullPointerException - The parameter str is null.

• IllegalArgumentException - The parameter str is empty or syntactically invalid.

toString

public String toString()

Converts this object to a text string of the media type it represents, in the same form as MediaType.toString.

Overrides:

• toString in class Object

Returns:

• A string representation of this object.

Back to MailLib start page.