matlab.net.http.field.GenericParameterizedField クラス

名前空間: matlab.net.http.field
スーパークラス: matlab.net.http.field.GenericField

パラメーター化された構文をサポートする GenericField

説明

GenericParameterizedField オブジェクトは次のパラメーター化された構文をサポートする GenericField オブジェクトの 1 つのバージョンです。

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

Type はトークンであり、各 param=value のペアはパラメーターの名前と値を表します。Type はオプションですが、サブクラスで必要になる場合があります。GenericField とは異なり、このフィールドでは要素のコンマ区切りリストではなく、単一セットのパラメーター (まとめて "要素" と呼ばれる) のみがサポートされます。

作成

説明

obj = GenericParameterizedField(name,value) は Name プロパティを name に、Value プロパティを value に設定して、HTTP ヘッダー フィールドを作成します。value が string または文字ベクトルである場合、value はそのまま使用されます。それ以外の場合、MATLAB^® は string に変換しようとします。

value には、型とセミコロン区切りのパラメーターのリストが次の形式で含まれていなければなりません。ここで type は Type プロパティの値で、各 param=value はパラメーターを定義します。ただし、MATLAB は value のこの構文を強制しません。

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

value が N 行 2 列の string 行列の場合、行列の各行はフィールドの param=value パラメーターを次の形式で表します。

""     type
param1 value1
param2 value2

空の名前をもつ行はすべて、名前のない値としてフィールドに表示されます。通常、最初の行は Type です。コンストラクターのこの形式を使用すると、MATLAB はパラメーター名と型が正しいトークンかどうかをチェックします。param=value のペアの場合、MATLAB は予約文字を含む値がまだ引用符で囲まれていない場合は引用符で囲み、二重引用符をエスケープします。

型はオプションです。設定しない場合、Type プロパティを使用するか、setParameter(obj,"",type) メソッドを呼び出して後で設定できます。

obj = GenericParameterizedField(name,type,Name,Value) は、type に設定した Type プロパティと 1 つ以上の Name,Value のペアの引数で指定された追加のオプションのパラメーターでヘッダー フィールドを作成します。

この構文は、次の string 行列引数を指定する場合とほぼ同じになります。

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

プロパティ

Type — フィールドの Type プロパティ

string | string 配列

フィールドの Type プロパティ。string として指定されます。この値は、名前と値のペアの一部ではない、フィールドの値にある任意のトークンと等しくなります。これが複数ある場合、Type はこのようなトークンをすべて含む string 配列です。値の開始位置には通常、その値の型と見なされる 1 つのトークンのみがあります。

たとえば、以下のステートメントで Type プロパティは MYTYPE です。

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

以下のステートメントには Type がないため、Type プロパティは "" です。

foo=bar; abc=def; hij=klm

すべてのトークンを削除するには、Type を空の配列または空の string に設定します。

属性:

GetAccess	public
SetAccess	public
Dependent	true

Name — フィールド名

string | 文字ベクトル

フィールド名。string または文字ベクトルとして指定します。このプロパティはスーパークラス matlab.net.http.HeaderField から継承されます。

属性:

GetAccess	public
SetAccess	public

Value — フィールド値

string | Name に対して有効な任意のタイプ

フィールド値。string または Name プロパティに対して有効な任意のタイプとして指定します。このプロパティはスーパークラス matlab.net.http.HeaderField から継承されます。

属性:

GetAccess	public
SetAccess	public
Dependent	true

メソッド

パブリック メソッド

getParameter	フィールドでのパラメーターの戻り値
setParameter	フィールドでパラメーターの値を設定
removeParameter	フィールドからパラメーターを削除
addFields	HeaderField 配列へのフィールドの追加
removeFields	ヘッダー フィールド配列からフィールドを削除
changeFields	HeaderField 配列内の既存値を変更
replaceFields	HeaderFields の配列の値を変更またはフィールドを追加
getFields	名前またはクラスが一致するヘッダー フィールドを返す
eq	2 つの HeaderField 配列の比較
convertLike	ヘッダー フィールド値を別のヘッダー フィールドと同様に変換
parse	ヘッダー フィールド値を解析して string として返す
displaySubclasses	サポートされる HeaderField サブクラスの表示

サブクラスに特化

convert

パラメーター名と値の行列としての Value プロパティ。列 1 にはパラメーター名、列 2 にはその値が含まれます。Type プロパティなど名前のないパラメーターの場合、列 1 には "" が含まれます。

特殊な演算子と関数

次のメソッドは、MATLAB の標準の演算子および関数を、このクラスのオブジェクト用に特殊化したものです。

isequal	eq メソッドで示されているように、2 つのヘッダー フィールド配列が同じサイズで、対応する要素が等しい場合は true
string	string としてのヘッダー フィールドの配列。メッセージに表示されます。フィールド間に改行文字を挿入しますが、すべてのフィールドの最後には挿入しません。
char	string メソッドで示されているように、文字ベクトルとしてのヘッダー フィールドの配列

バージョン履歴

R2018a で導入