Class CharFilter

java.lang.Object

com.azure.search.documents.indexes.models.CharFilter

All Implemented Interfaces:

com.azure.json.JsonSerializable<CharFilter>

Direct Known Subclasses:

MappingCharFilter, PatternReplaceCharFilter

public class CharFilter
extends Object
implements com.azure.json.JsonSerializable<CharFilter>

Base type for character filters.

Constructor Summary

Constructors

Constructor	Description
CharFilter(String name)	Creates an instance of CharFilter class.

Method Summary

Modifier and Type	Method	Description
static CharFilter	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of CharFilter from the JsonReader.
String	getName()	Get the name property: The name of the char filter.
String	getOdataType()	Get the odataType property: A URI fragment specifying the type of char filter.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

CharFilter

public CharFilter(String name)

Creates an instance of CharFilter class.

Parameters:

name - the name value to set.

Method Details

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of char filter.

Returns:

the odataType value.

getName

public String getName()

Get the name property: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

Returns:

the name value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<CharFilter>

Throws:

IOException

fromJson

public static CharFilter fromJson(com.azure.json.JsonReader jsonReader)
                           throws IOException

Reads an instance of CharFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CharFilter if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the CharFilter.