matlab.net.http.field.GenericField Class

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

HTTP header field with any name and value

Description

Use a GenericField header field for testing or to work around a built-in restriction that might not be appropriate for your application. The HeaderField class and its subclasses validate the Value property for the given Name property. To override a Value that might otherwise be rejected, create a GenericField header field.

If a header field in a response message contains a value that is not valid for the field name, then MATLAB^® creates a GenericField object.

Class Attributes

Sealed

true

For information on class attributes, see Class Attributes.

Creation

Description

obj = matlab.net.http.field.GenericField(name,value) creates an HTTP header field with the Name property set to name and the Value property set to value.

Properties

Name — Header field name

string | character vector

Header field name, specified as a string or character vector.

Attributes:

GetAccess	public
SetAccess	public

Value — Header value

string | character vector

Header value, specified as a string or character vector.

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 of header field as MATLAB type. MATLAB checks the matlab.net.http.field namespace for a class with the GenericField.Name property. If there is a class for this field, then convert invokes the convert method of that class. If the conversion fails or if no class supports this Name property, then convert throws an exception.

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

Examples

Override Content-Length Header Field Value

A Content-Length header field must contain a number.

The following statement generates an error.

field = matlab.net.http.field.ContentLengthField('abc');

For a character value, create a GenericField object.

field = matlab.net.http.field.GenericField('Content-Length','abc');

Version History

Introduced in R2016b