### YamlMime:JavaType
uid: "com.azure.search.models.PhoneticTokenFilter"
fullName: "com.azure.search.models.PhoneticTokenFilter"
name: "PhoneticTokenFilter"
nameWithType: "PhoneticTokenFilter"
summary: "Create tokens for phonetic matches."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.models.TokenFilter?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.search.models.TokenFilter?alt=com.azure.search.models.TokenFilter&text=TokenFilter\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"com.azure.search.models.TokenFilter.getName()?alt=com.azure.search.models.TokenFilter.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.search.models.TokenFilter.setName(java.lang.String)?alt=com.azure.search.models.TokenFilter.setName&text=setName\" 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 **PhoneticTokenFilter**</br> extends <xref href=\"com.azure.search.models.TokenFilter?alt=com.azure.search.models.TokenFilter&text=TokenFilter\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.search.models.PhoneticTokenFilter.PhoneticTokenFilter()"
  fullName: "com.azure.search.models.PhoneticTokenFilter.PhoneticTokenFilter()"
  name: "PhoneticTokenFilter()"
  nameWithType: "PhoneticTokenFilter.PhoneticTokenFilter()"
  syntax: "public PhoneticTokenFilter()"
methods:
- uid: "com.azure.search.models.PhoneticTokenFilter.getEncoder()"
  fullName: "com.azure.search.models.PhoneticTokenFilter.getEncoder()"
  name: "getEncoder()"
  nameWithType: "PhoneticTokenFilter.getEncoder()"
  summary: "Get the encoder property: The phonetic encoder to use."
  syntax: "public PhoneticEncoder getEncoder()"
  desc: "Get the encoder property: The phonetic encoder to use. Default is \"metaphone\". Possible values include: 'metaphone', 'doubleMetaphone', 'soundex', 'refinedSoundex', 'caverphone1', 'caverphone2', 'cologne', 'nysiis', 'koelnerPhonetik', 'haasePhonetik', 'beiderMorse'."
  returns:
    description: "the encoder value."
    type: "<xref href=\"com.azure.search.models.PhoneticEncoder?alt=com.azure.search.models.PhoneticEncoder&text=PhoneticEncoder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.PhoneticTokenFilter.isReplaceOriginalTokens()"
  fullName: "com.azure.search.models.PhoneticTokenFilter.isReplaceOriginalTokens()"
  name: "isReplaceOriginalTokens()"
  nameWithType: "PhoneticTokenFilter.isReplaceOriginalTokens()"
  summary: "Get the replace<wbr>Original<wbr>Tokens property: A value indicating whether encoded tokens should replace original tokens."
  syntax: "public Boolean isReplaceOriginalTokens()"
  desc: "Get the replaceOriginalTokens property: A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true."
  returns:
    description: "the replaceOriginalTokens value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.search.models.PhoneticTokenFilter.setEncoder(com.azure.search.models.PhoneticEncoder)"
  fullName: "com.azure.search.models.PhoneticTokenFilter.setEncoder(PhoneticEncoder encoder)"
  name: "setEncoder(PhoneticEncoder encoder)"
  nameWithType: "PhoneticTokenFilter.setEncoder(PhoneticEncoder encoder)"
  summary: "Set the encoder property: The phonetic encoder to use."
  parameters:
  - description: "the encoder value to set."
    name: "encoder"
    type: "<xref href=\"com.azure.search.models.PhoneticEncoder?alt=com.azure.search.models.PhoneticEncoder&text=PhoneticEncoder\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public PhoneticTokenFilter setEncoder(PhoneticEncoder encoder)"
  desc: "Set the encoder property: The phonetic encoder to use. Default is \"metaphone\". Possible values include: 'metaphone', 'doubleMetaphone', 'soundex', 'refinedSoundex', 'caverphone1', 'caverphone2', 'cologne', 'nysiis', 'koelnerPhonetik', 'haasePhonetik', 'beiderMorse'."
  returns:
    description: "the PhoneticTokenFilter object itself."
    type: "<xref href=\"com.azure.search.models.PhoneticTokenFilter?alt=com.azure.search.models.PhoneticTokenFilter&text=PhoneticTokenFilter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.PhoneticTokenFilter.setReplaceOriginalTokens(java.lang.Boolean)"
  fullName: "com.azure.search.models.PhoneticTokenFilter.setReplaceOriginalTokens(Boolean replaceOriginalTokens)"
  name: "setReplaceOriginalTokens(Boolean replaceOriginalTokens)"
  nameWithType: "PhoneticTokenFilter.setReplaceOriginalTokens(Boolean replaceOriginalTokens)"
  summary: "Set the replace<wbr>Original<wbr>Tokens property: A value indicating whether encoded tokens should replace original tokens."
  parameters:
  - description: "the replaceOriginalTokens value to set."
    name: "replaceOriginalTokens"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
  syntax: "public PhoneticTokenFilter setReplaceOriginalTokens(Boolean replaceOriginalTokens)"
  desc: "Set the replaceOriginalTokens property: A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true."
  returns:
    description: "the PhoneticTokenFilter object itself."
    type: "<xref href=\"com.azure.search.models.PhoneticTokenFilter?alt=com.azure.search.models.PhoneticTokenFilter&text=PhoneticTokenFilter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Create tokens for phonetic matches. This token filter is implemented using Apache Lucene."
metadata: {}
package: "com.azure.search.models"
artifact: com.azure:azure-search:11.0.0-beta.1