### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter"
fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter"
name: "ShingleTokenFilter"
nameWithType: "ShingleTokenFilter"
summary: "Creates combinations of tokens as a single token."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter?alt=com.azure.search.documents.indexes.models.TokenFilter&text=TokenFilter\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter.fromJson(com.azure.json.JsonReader)?alt=com.azure.search.documents.indexes.models.TokenFilter.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter.getName()?alt=com.azure.search.documents.indexes.models.TokenFilter.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter.getOdataType()?alt=com.azure.search.documents.indexes.models.TokenFilter.getOdataType&text=getOdataType\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter.toJson(com.azure.json.JsonWriter)?alt=com.azure.search.documents.indexes.models.TokenFilter.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **ShingleTokenFilter**</br> extends <xref href=\"com.azure.search.documents.indexes.models.TokenFilter?alt=com.azure.search.documents.indexes.models.TokenFilter&text=TokenFilter\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.ShingleTokenFilter(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.ShingleTokenFilter(String name)"
  name: "ShingleTokenFilter(String name)"
  nameWithType: "ShingleTokenFilter.ShingleTokenFilter(String name)"
  summary: "Creates an instance of Shingle<wbr>Token<wbr>Filter class."
  parameters:
  - description: "the name value to set."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ShingleTokenFilter(String name)"
  desc: "Creates an instance of ShingleTokenFilter class."
methods:
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.areOutputUnigrams()"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.areOutputUnigrams()"
  name: "areOutputUnigrams()"
  nameWithType: "ShingleTokenFilter.areOutputUnigrams()"
  summary: "Get the output<wbr>Unigrams property: A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles."
  syntax: "public Boolean areOutputUnigrams()"
  desc: "Get the outputUnigrams property: A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true."
  returns:
    description: "the outputUnigrams value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.areOutputUnigramsIfNoShingles()"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.areOutputUnigramsIfNoShingles()"
  name: "areOutputUnigramsIfNoShingles()"
  nameWithType: "ShingleTokenFilter.areOutputUnigramsIfNoShingles()"
  summary: "Get the output<wbr>Unigrams<wbr>IfNo<wbr>Shingles property: A value indicating whether to output unigrams for those times when no shingles are available."
  syntax: "public Boolean areOutputUnigramsIfNoShingles()"
  desc: "Get the outputUnigramsIfNoShingles property: A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false."
  returns:
    description: "the outputUnigramsIfNoShingles value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "ShingleTokenFilter.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Shingle<wbr>Token<wbr>Filter from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static ShingleTokenFilter fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of ShingleTokenFilter from the JsonReader."
  returns:
    description: "An instance of ShingleTokenFilter if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ShingleTokenFilter?alt=com.azure.search.documents.indexes.models.ShingleTokenFilter&text=ShingleTokenFilter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getFilterToken()"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getFilterToken()"
  name: "getFilterToken()"
  nameWithType: "ShingleTokenFilter.getFilterToken()"
  summary: "Get the filter<wbr>Token property: The string to insert for each position at which there is no token."
  syntax: "public String getFilterToken()"
  desc: "Get the filterToken property: The string to insert for each position at which there is no token. Default is an underscore (\"\\_\")."
  returns:
    description: "the filterToken value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getMaxShingleSize()"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getMaxShingleSize()"
  name: "getMaxShingleSize()"
  nameWithType: "ShingleTokenFilter.getMaxShingleSize()"
  summary: "Get the max<wbr>Shingle<wbr>Size property: The maximum shingle size."
  syntax: "public Integer getMaxShingleSize()"
  desc: "Get the maxShingleSize property: The maximum shingle size. Default and minimum value is 2."
  returns:
    description: "the maxShingleSize value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getMinShingleSize()"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getMinShingleSize()"
  name: "getMinShingleSize()"
  nameWithType: "ShingleTokenFilter.getMinShingleSize()"
  summary: "Get the min<wbr>Shingle<wbr>Size property: The minimum shingle size."
  syntax: "public Integer getMinShingleSize()"
  desc: "Get the minShingleSize property: The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize."
  returns:
    description: "the minShingleSize value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getOdataType()"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getOdataType()"
  name: "getOdataType()"
  nameWithType: "ShingleTokenFilter.getOdataType()"
  summary: "Get the odata<wbr>Type property: A URI fragment specifying the type of token filter."
  overridden: "com.azure.search.documents.indexes.models.TokenFilter.getOdataType()"
  syntax: "public String getOdataType()"
  desc: "Get the odataType property: A URI fragment specifying the type of token filter."
  returns:
    description: "the odataType value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getTokenSeparator()"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.getTokenSeparator()"
  name: "getTokenSeparator()"
  nameWithType: "ShingleTokenFilter.getTokenSeparator()"
  summary: "Get the token<wbr>Separator property: The string to use when joining adjacent tokens to form a shingle."
  syntax: "public String getTokenSeparator()"
  desc: "Get the tokenSeparator property: The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")."
  returns:
    description: "the tokenSeparator value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setFilterToken(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setFilterToken(String filterToken)"
  name: "setFilterToken(String filterToken)"
  nameWithType: "ShingleTokenFilter.setFilterToken(String filterToken)"
  summary: "Set the filter<wbr>Token property: The string to insert for each position at which there is no token."
  parameters:
  - description: "the filterToken value to set."
    name: "filterToken"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ShingleTokenFilter setFilterToken(String filterToken)"
  desc: "Set the filterToken property: The string to insert for each position at which there is no token. Default is an underscore (\"\\_\")."
  returns:
    description: "the ShingleTokenFilter object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ShingleTokenFilter?alt=com.azure.search.documents.indexes.models.ShingleTokenFilter&text=ShingleTokenFilter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setMaxShingleSize(java.lang.Integer)"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setMaxShingleSize(Integer maxShingleSize)"
  name: "setMaxShingleSize(Integer maxShingleSize)"
  nameWithType: "ShingleTokenFilter.setMaxShingleSize(Integer maxShingleSize)"
  summary: "Set the max<wbr>Shingle<wbr>Size property: The maximum shingle size."
  parameters:
  - description: "the maxShingleSize value to set."
    name: "maxShingleSize"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public ShingleTokenFilter setMaxShingleSize(Integer maxShingleSize)"
  desc: "Set the maxShingleSize property: The maximum shingle size. Default and minimum value is 2."
  returns:
    description: "the ShingleTokenFilter object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ShingleTokenFilter?alt=com.azure.search.documents.indexes.models.ShingleTokenFilter&text=ShingleTokenFilter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setMinShingleSize(java.lang.Integer)"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setMinShingleSize(Integer minShingleSize)"
  name: "setMinShingleSize(Integer minShingleSize)"
  nameWithType: "ShingleTokenFilter.setMinShingleSize(Integer minShingleSize)"
  summary: "Set the min<wbr>Shingle<wbr>Size property: The minimum shingle size."
  parameters:
  - description: "the minShingleSize value to set."
    name: "minShingleSize"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public ShingleTokenFilter setMinShingleSize(Integer minShingleSize)"
  desc: "Set the minShingleSize property: The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize."
  returns:
    description: "the ShingleTokenFilter object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ShingleTokenFilter?alt=com.azure.search.documents.indexes.models.ShingleTokenFilter&text=ShingleTokenFilter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setOutputUnigrams(java.lang.Boolean)"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setOutputUnigrams(Boolean outputUnigrams)"
  name: "setOutputUnigrams(Boolean outputUnigrams)"
  nameWithType: "ShingleTokenFilter.setOutputUnigrams(Boolean outputUnigrams)"
  summary: "Set the output<wbr>Unigrams property: A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles."
  parameters:
  - description: "the outputUnigrams value to set."
    name: "outputUnigrams"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
  syntax: "public ShingleTokenFilter setOutputUnigrams(Boolean outputUnigrams)"
  desc: "Set the outputUnigrams property: A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true."
  returns:
    description: "the ShingleTokenFilter object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ShingleTokenFilter?alt=com.azure.search.documents.indexes.models.ShingleTokenFilter&text=ShingleTokenFilter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setOutputUnigramsIfNoShingles(java.lang.Boolean)"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setOutputUnigramsIfNoShingles(Boolean outputUnigramsIfNoShingles)"
  name: "setOutputUnigramsIfNoShingles(Boolean outputUnigramsIfNoShingles)"
  nameWithType: "ShingleTokenFilter.setOutputUnigramsIfNoShingles(Boolean outputUnigramsIfNoShingles)"
  summary: "Set the output<wbr>Unigrams<wbr>IfNo<wbr>Shingles property: A value indicating whether to output unigrams for those times when no shingles are available."
  parameters:
  - description: "the outputUnigramsIfNoShingles value to set."
    name: "outputUnigramsIfNoShingles"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
  syntax: "public ShingleTokenFilter setOutputUnigramsIfNoShingles(Boolean outputUnigramsIfNoShingles)"
  desc: "Set the outputUnigramsIfNoShingles property: A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false."
  returns:
    description: "the ShingleTokenFilter object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ShingleTokenFilter?alt=com.azure.search.documents.indexes.models.ShingleTokenFilter&text=ShingleTokenFilter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setTokenSeparator(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.setTokenSeparator(String tokenSeparator)"
  name: "setTokenSeparator(String tokenSeparator)"
  nameWithType: "ShingleTokenFilter.setTokenSeparator(String tokenSeparator)"
  summary: "Set the token<wbr>Separator property: The string to use when joining adjacent tokens to form a shingle."
  parameters:
  - description: "the tokenSeparator value to set."
    name: "tokenSeparator"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ShingleTokenFilter setTokenSeparator(String tokenSeparator)"
  desc: "Set the tokenSeparator property: The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")."
  returns:
    description: "the ShingleTokenFilter object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ShingleTokenFilter?alt=com.azure.search.documents.indexes.models.ShingleTokenFilter&text=ShingleTokenFilter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ShingleTokenFilter.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.ShingleTokenFilter.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "ShingleTokenFilter.toJson(JsonWriter jsonWriter)"
  overridden: "com.azure.search.documents.indexes.models.TokenFilter.toJson(com.azure.json.JsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene."
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.3