matlab.net.http.field.GenericParameterizedField Class

Namespace: matlab.net.http.field
Superclasses: matlab.net.http.field.GenericField

GenericField to support parameterized syntax

Description

A GenericParameterizedField object is a version of a GenericField object that supports the following parameterized syntax.

Type; param1=value1; param2=value2; param3=value3; ...

Type is a token and each param=value pair represents the name and value of a parameter. Type is optional, though subclasses can require it. Unlike GenericField, this field only supports a single set of parameters (collectively called an "element"), not a comma-separated list of elements.

Creation

Description

obj = GenericParameterizedField(name,value) creates an HTTP header field with the Name property set to name and the Value property set to value. If value is a string or character vector, then value is used as is. Otherwise, MATLAB^® attempts to convert it to a string.

value should contain a type and semicolon-separated list of parameters in the following form, where type is the value of the Type property and each param=value defines a parameter. However, MATLAB does not enforce this syntax of value.

type; param1=value1; param2=value2; param3=value3; ...

If value is an Nx2 string matrix, each row of the matrix represents a param=value parameter of the field, in the form:

""     type
param1 value1
param2 value2

Any row with an empty name appears in the field as a value without a name. Normally the first row is the Type. When using this form of the constructor, MATLAB checks that the param names and the type are legal tokens. For param=value pairs, MATLAB quotes values that contain reserved characters, if they are not already quoted, and escapes double-quotes.

The type is optional. If not set, then it can be set later using the Type property or by calling the method setParameter(obj,"",type).

obj = GenericParameterizedField(name,type,Name,Value) creates a header field with the Type property set to type and parameters with additional options specified by one or more Name,Value pair arguments.

This syntax is roughly the same as specifying the following string matrix argument:

obj = GenericParameterizedField(NAME, ["" TYPE; PARAM1 VALUE1; PARAM2 VALUE2; ...])

Properties

Type — Field Type property

string | string array

Field Type property specified as a string. The value is equal to any token in the field's value that is not part of a name=value pair. If there is more than one, then Type is a string array containing all such tokens. There is normally one token at the start of the value that is considered the type of the value.

For example, in the following statement, the Type property is MYTYPE.

MYTYPE; foo=bar; abc=def; hij=klm

In the following statement, there is no Type, so the Type property is "".

foo=bar; abc=def; hij=klm

To remove all tokens, set Type to an empty array or an empty string.

Attributes:

GetAccess	public
SetAccess	public
Dependent	true

Name — Field name

string | character vector

Field name specified as a string or character vector. This property is inherited from superclass matlab.net.http.HeaderField.

Attributes:

GetAccess	public
SetAccess	public

Value — Field value

string | any type valid for Name

Field value specified as a string or any type valid for the Name property. This property is inherited from superclass matlab.net.http.HeaderField.

Attributes:

GetAccess	public
SetAccess	public
Dependent	true

Methods

Public Methods

getParameter	Return value of parameter in field
setParameter	Set value of parameter in field
removeParameter	Remove parameter from field
addFields	Add fields to HeaderField array
removeFields	Remove fields from header field array
changeFields	Change existing values in HeaderField array
replaceFields	Change values in or add fields to array of HeaderFields
getFields	Return header fields matching name or class
eq	Compare two HeaderField arrays
convertLike	Convert header field value like another header field
parse	Parse header field value and return as strings
displaySubclasses	Display supported HeaderField subclasses

Specialized for Subclass

convert

Value property as matrix of parameter names and values. Column 1 contains the name of the parameter and column 2 is its value. For an unnamed parameter, for example the Type property, column 1 contains "".

Specialized Operators and Functions

These methods specialize standard MATLAB operators and functions for objects in this class.

isequal	true if two header field arrays are the same size and corresponding elements are equal, as described by eq method
string	Array of header fields as string, as it appears in a message. Inserts newline characters between fields but not at the end of all fields.
char	Array of header fields as character vector, as described by string method

Version History

Introduced in R2018a