Index (nameapi-client 5.4.1 API)

A B C D E F G H I J M N O P R S T V W
All Classes All Packages

A

AccessDeniedNoSuchAccount - org.nameapi.client.services.development.exceptionthrower.ExceptionType
add(NameParserRule) - Method in class org.nameapi.client.services.nameparser.syntax.RuleCollector
API_KEY - Static variable in interface org.nameapi.client.lib.NameApiKeys: The api key is required for any call to NameAPI services.
asList() - Method in class org.nameapi.client.services.nameparser.syntax.RuleCollector
assertSize(int) - Static method in enum org.nameapi.client.services.development.exceptionthrower.ExceptionType: Developer: Call this before doing a switch on an enum value.

B

build() - Method in class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerParams.Builder
Builder() - Constructor for class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerParams.Builder

C

call(Optional<String>, ExecutionContext) - Method in class org.nameapi.client.services.email.disposableemailaddressdetector.DisposableEmailAddressDetectorCommand
call(Optional<String>, ExecutionContext) - Method in class org.nameapi.client.services.email.emaildomaintypeclassifier.EmailDomainTypeClassifierCommand
call(Optional<String>, ExecutionContext) - Method in class org.nameapi.client.services.email.emailnameparser.EmailNameParserCommand
call(Optional<Void>, ExecutionContext) - Method in class org.nameapi.client.services.system.ping.PingCommand
call(Optional<ExceptionThrowerParams>, ExecutionContext) - Method in class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerCommand
call(Optional<PersonNameFormatterArgument>, ExecutionContext) - Method in class org.nameapi.client.services.formatter.personnameformatter.PersonNameFormatterCommand
call(Optional<PersonMatcherArgument>, ExecutionContext) - Method in class org.nameapi.client.services.matcher.personmatcher.PersonMatcherCommand
call(Optional<InputPerson>, ExecutionContext) - Method in class org.nameapi.client.services.genderizer.persongenderizer.PersonGenderizerCommand
call(Optional<InputPerson>, ExecutionContext) - Method in class org.nameapi.client.services.parser.personnameparser.PersonNameParserCommand
call(Optional<InputPerson>, ExecutionContext) - Method in class org.nameapi.client.services.riskdetector.person.PersonRiskDetectorCommand
CLIENT_VERSION - Static variable in class org.nameapi.client.services.NameApiBaseCommand
containsIgnoreCase(String[], String) - Static method in class org.nameapi.client.RestStringUtil: Check if the given array contains the given value (with case-insensitive comparison).
CONTEXT - Static variable in interface org.nameapi.client.lib.NameApiKeys: The context is used as an optional argument by many of the NameApi services.
create() - Static method in class org.nameapi.client.lib.NameApiRemoteExecutors
createPort(ExecutionContext) - Method in class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerCommand
createPort(ExecutionContext) - Method in class org.nameapi.client.services.email.disposableemailaddressdetector.DisposableEmailAddressDetectorCommand
createPort(ExecutionContext) - Method in class org.nameapi.client.services.email.emaildomaintypeclassifier.EmailDomainTypeClassifierCommand
createPort(ExecutionContext) - Method in class org.nameapi.client.services.email.emailnameparser.EmailNameParserCommand
createPort(ExecutionContext) - Method in class org.nameapi.client.services.formatter.personnameformatter.PersonNameFormatterCommand
createPort(ExecutionContext) - Method in class org.nameapi.client.services.genderizer.persongenderizer.PersonGenderizerCommand
createPort(ExecutionContext) - Method in class org.nameapi.client.services.matcher.personmatcher.PersonMatcherCommand
createPort(ExecutionContext) - Method in class org.nameapi.client.services.parser.personnameparser.PersonNameParserCommand
createPort(ExecutionContext) - Method in class org.nameapi.client.services.riskdetector.person.PersonRiskDetectorCommand
createPort(ExecutionContext) - Method in class org.nameapi.client.services.system.ping.PingCommand
createUrl(Host) - Method in class org.nameapi.client.lib.NameApiPortUrlFactory

D

DisposableEmailAddressDetectorCommand - Class in org.nameapi.client.services.email.disposableemailaddressdetector: Detects disposable email addresses "DEA", also known as trash email addresses such as "foo@mailinator.com".
DisposableEmailAddressDetectorCommand() - Constructor for class org.nameapi.client.services.email.disposableemailaddressdetector.DisposableEmailAddressDetectorCommand

E

EmailDomainTypeClassifierCommand - Class in org.nameapi.client.services.email.emaildomaintypeclassifier: Classifies the domain name of an email address as FREEMAIL, ORGANIZATION etc.
EmailDomainTypeClassifierCommand() - Constructor for class org.nameapi.client.services.email.emaildomaintypeclassifier.EmailDomainTypeClassifierCommand
EmailNameParserCommand - Class in org.nameapi.client.services.email.emailnameparser: Analyzes the email address and attempts to extract a person's name.
EmailNameParserCommand() - Constructor for class org.nameapi.client.services.email.emailnameparser.EmailNameParserCommand
empty() - Static method in class org.nameapi.client.services.nameparser.fieldnameparser.FieldNameParserResult
equals(Object) - Method in class org.nameapi.client.services.nameparser.syntax.NameParserRule
exceptionChance(int) - Method in class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerParams.Builder
ExceptionThrowerCommand - Class in org.nameapi.client.services.development.exceptionthrower: Tells the server to throw an exception.
ExceptionThrowerCommand() - Constructor for class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerCommand
ExceptionThrowerParams - Class in org.nameapi.client.services.development.exceptionthrower
ExceptionThrowerParams(ExceptionType, int) - Constructor for class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerParams
ExceptionThrowerParams.Builder - Class in org.nameapi.client.services.development.exceptionthrower
exceptionType(ExceptionType) - Method in class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerParams.Builder
ExceptionType - Enum in org.nameapi.client.services.development.exceptionthrower: Types that the server throws.

F

FieldNameParserCommand - Class in org.nameapi.client.services.nameparser.fieldnameparser: Service currently not available as public API.
FieldNameParserCommand() - Constructor for class org.nameapi.client.services.nameparser.fieldnameparser.FieldNameParserCommand
FieldNameParserResult - Class in org.nameapi.client.services.nameparser.fieldnameparser: The result of a FieldNameParserCommand.
FieldNameParserResult(List<Match>) - Constructor for class org.nameapi.client.services.nameparser.fieldnameparser.FieldNameParserResult

G

get() - Static method in class org.nameapi.client.lib.NameApiRemoteExecutors
getApiKey(ExecutionContext) - Method in class org.nameapi.client.services.NameApiBaseCommand
getBestMatch() - Method in class org.nameapi.client.services.nameparser.NameParserResult
getChance() - Method in class org.nameapi.client.services.nameparser.syntax.NameParserRule
getConfidence() - Method in class org.nameapi.client.services.nameparser.fieldnameparser.MatchItem
getConfidence() - Method in class org.nameapi.client.services.nameparser.Match
getContext(ExecutionContext) - Method in class org.nameapi.client.services.NameApiBaseCommand
getCulture() - Method in class org.nameapi.client.services.nameparser.Match
getExceptionChance() - Method in class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerParams
getExceptionType() - Method in class org.nameapi.client.services.development.exceptionthrower.ExceptionThrowerParams
getInputPerson() - Method in class org.nameapi.client.services.formatter.personnameformatter.PersonNameFormatterArgument
getInputPerson1() - Method in class org.nameapi.client.services.matcher.personmatcher.PersonMatcherArgument
getInputPerson2() - Method in class org.nameapi.client.services.matcher.personmatcher.PersonMatcherArgument
getItemCount() - Method in class org.nameapi.client.services.nameparser.Match
getItemsAsStrings() - Method in class org.nameapi.client.services.nameparser.Match
getLikeliness() - Method in class org.nameapi.client.services.nameparser.fieldnameparser.Match
getLikeliness() - Method in class org.nameapi.client.services.nameparser.fieldnameparser.MatchItem
getMatches() - Method in class org.nameapi.client.services.nameparser.fieldnameparser.FieldNameParserResult
getMatches() - Method in class org.nameapi.client.services.nameparser.NameParserResult
getMatchItems() - Method in class org.nameapi.client.services.nameparser.fieldnameparser.Match
getName() - Method in class org.nameapi.client.services.nameparser.syntax.NameParserRule
getNameString() - Method in class org.nameapi.client.services.nameparser.syntax.NameParserArgument
getProperties() - Method in class org.nameapi.client.services.formatter.personnameformatter.PersonNameFormatterArgument
getRuleChance() - Method in class org.nameapi.client.services.nameparser.Match
getRuleName() - Method in class org.nameapi.client.services.nameparser.Match
getRules() - Method in class org.nameapi.client.services.nameparser.syntax.NameParserArgument
getShortestItemCount() - Method in class org.nameapi.client.services.nameparser.NameParserResult
getSyntax() - Method in class org.nameapi.client.services.nameparser.syntax.NameParserRule
getTerm() - Method in class org.nameapi.client.services.nameparser.fieldnameparser.MatchItem

H

hashCode() - Method in class org.nameapi.client.services.nameparser.syntax.NameParserRule

I

InternalServerError - org.nameapi.client.services.development.exceptionthrower.ExceptionType
InvalidInput - org.nameapi.client.services.development.exceptionthrower.ExceptionType

J

join(String[], String) - Static method in class org.nameapi.client.RestStringUtil: Join an array of strings with the given separator.

M

makeClient(ExecutionContext) - Method in class org.nameapi.client.services.NameApiBaseCommand
Match - Class in org.nameapi.client.services.nameparser.fieldnameparser
Match - Class in org.nameapi.client.services.nameparser
Match(int, String, int, List<String>, int, String) - Constructor for class org.nameapi.client.services.nameparser.Match
Match(List<MatchItem>, double) - Constructor for class org.nameapi.client.services.nameparser.fieldnameparser.Match
MatchItem - Class in org.nameapi.client.services.nameparser.fieldnameparser
MatchItem(Term, double, double) - Constructor for class org.nameapi.client.services.nameparser.fieldnameparser.MatchItem
minimal(String) - Static method in class org.nameapi.client.lib.NameApiModeFactory: Overloaded method that uses for host: new Host("api.nameapi.org", Protocol.HTTPS) for port url: NameApiPortUrlFactory.versionLatestStable()
minimal(String, Host, RestPortUrlFactory) - Static method in class org.nameapi.client.lib.NameApiModeFactory: You can take this and extend for your setup if you need more.

N

NameApiBaseCommand<T,A,R> - Class in org.nameapi.client.services: Adds NameAPI-specific functionality to the BaseCommand.
NameApiBaseCommand(Class<T>) - Constructor for class org.nameapi.client.services.NameApiBaseCommand
NameApiKeys - Interface in org.nameapi.client.lib: A place of keys used by this NameAPI library.
NameApiModeFactory - Class in org.nameapi.client.lib: Provides Mode instances that contain the minimum.
NameApiModeFactory() - Constructor for class org.nameapi.client.lib.NameApiModeFactory
NameApiPortUrlFactory - Class in org.nameapi.client.lib
NameApiRemoteExecutors - Class in org.nameapi.client.lib: When adding extensions here, it's like adding default interceptors or default-whatever to any command that executes.
NameApiRemoteExecutors() - Constructor for class org.nameapi.client.lib.NameApiRemoteExecutors
NameParserArgument - Class in org.nameapi.client.services.nameparser.syntax: The input for the SyntaxBasedNameParserCommand.
NameParserArgument(String, List<NameParserRule>) - Constructor for class org.nameapi.client.services.nameparser.syntax.NameParserArgument
NameParserResult - Class in org.nameapi.client.services.nameparser
NameParserResult(Match, List<Match>, int) - Constructor for class org.nameapi.client.services.nameparser.NameParserResult
NameParserRule - Class in org.nameapi.client.services.nameparser.syntax
NameParserRule(String, int, String) - Constructor for class org.nameapi.client.services.nameparser.syntax.NameParserRule

O

org.nameapi.client - package org.nameapi.client
org.nameapi.client.lib - package org.nameapi.client.lib
org.nameapi.client.services - package org.nameapi.client.services
org.nameapi.client.services.development.exceptionthrower - package org.nameapi.client.services.development.exceptionthrower
org.nameapi.client.services.email.disposableemailaddressdetector - package org.nameapi.client.services.email.disposableemailaddressdetector
org.nameapi.client.services.email.emaildomaintypeclassifier - package org.nameapi.client.services.email.emaildomaintypeclassifier
org.nameapi.client.services.email.emailnameparser - package org.nameapi.client.services.email.emailnameparser
org.nameapi.client.services.formatter.personnameformatter - package org.nameapi.client.services.formatter.personnameformatter
org.nameapi.client.services.genderizer.persongenderizer - package org.nameapi.client.services.genderizer.persongenderizer
org.nameapi.client.services.matcher.personmatcher - package org.nameapi.client.services.matcher.personmatcher
org.nameapi.client.services.nameparser - package org.nameapi.client.services.nameparser
org.nameapi.client.services.nameparser.fieldnameparser - package org.nameapi.client.services.nameparser.fieldnameparser
org.nameapi.client.services.nameparser.syntax - package org.nameapi.client.services.nameparser.syntax
org.nameapi.client.services.parser.personnameparser - package org.nameapi.client.services.parser.personnameparser
org.nameapi.client.services.riskdetector.person - package org.nameapi.client.services.riskdetector.person
org.nameapi.client.services.system.ping - package org.nameapi.client.services.system.ping

P

PersonGenderizerCommand - Class in org.nameapi.client.services.genderizer.persongenderizer: Attempts to detect the person's gender based on the inputs, especially the person's name.
PersonGenderizerCommand() - Constructor for class org.nameapi.client.services.genderizer.persongenderizer.PersonGenderizerCommand
PersonMatcherArgument - Class in org.nameapi.client.services.matcher.personmatcher
PersonMatcherArgument(InputPerson, InputPerson) - Constructor for class org.nameapi.client.services.matcher.personmatcher.PersonMatcherArgument
PersonMatcherCommand - Class in org.nameapi.client.services.matcher.personmatcher: Compares two people and tells if and how they match.
PersonMatcherCommand() - Constructor for class org.nameapi.client.services.matcher.personmatcher.PersonMatcherCommand
PersonNameFormatterArgument - Class in org.nameapi.client.services.formatter.personnameformatter
PersonNameFormatterArgument(InputPerson, FormatterProperties) - Constructor for class org.nameapi.client.services.formatter.personnameformatter.PersonNameFormatterArgument
PersonNameFormatterCommand - Class in org.nameapi.client.services.formatter.personnameformatter: Service for formatting person names.
PersonNameFormatterCommand() - Constructor for class org.nameapi.client.services.formatter.personnameformatter.PersonNameFormatterCommand
PersonNameParserCommand - Class in org.nameapi.client.services.parser.personnameparser: Parses the name fields of a person's name.
PersonNameParserCommand() - Constructor for class org.nameapi.client.services.parser.personnameparser.PersonNameParserCommand
PersonRiskDetectorCommand - Class in org.nameapi.client.services.riskdetector.person
PersonRiskDetectorCommand() - Constructor for class org.nameapi.client.services.riskdetector.person.PersonRiskDetectorCommand
PingCommand - Class in org.nameapi.client.services.system.ping: The ping command simply pings the server and, on success, gets a "pong" back.
PingCommand() - Constructor for class org.nameapi.client.services.system.ping.PingCommand

R

restApiClient - Variable in class org.nameapi.client.services.RestServicePort
RestServicePort - Class in org.nameapi.client.services
RestServicePort(RestHttpClient, String) - Constructor for class org.nameapi.client.services.RestServicePort
RestStringUtil - Class in org.nameapi.client
RestStringUtil() - Constructor for class org.nameapi.client.RestStringUtil
RuleCollector - Class in org.nameapi.client.services.nameparser.syntax: Builder for the list of rules.
RuleCollector() - Constructor for class org.nameapi.client.services.nameparser.syntax.RuleCollector

S

servicePath - Variable in class org.nameapi.client.services.RestServicePort
SyntaxBasedNameParserCommand - Class in org.nameapi.client.services.nameparser.syntax: Service currently not available as public API.
SyntaxBasedNameParserCommand() - Constructor for class org.nameapi.client.services.nameparser.syntax.SyntaxBasedNameParserCommand

T

toIndentedString(Object) - Static method in class org.nameapi.client.RestStringUtil: Convert the given object to string with each line indented by 4 spaces (except the first line).
toList() - Method in class org.nameapi.client.services.nameparser.syntax.RuleCollector
toString() - Method in class org.nameapi.client.services.nameparser.Match
toString() - Method in class org.nameapi.client.services.nameparser.NameParserResult
toString() - Method in class org.nameapi.client.services.nameparser.syntax.NameParserRule
toString() - Method in class org.nameapi.client.services.nameparser.syntax.RuleCollector

V

valueOf(String) - Static method in enum org.nameapi.client.services.development.exceptionthrower.ExceptionType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.nameapi.client.services.development.exceptionthrower.ExceptionType: Returns an array containing the constants of this enum type, in the order they are declared.
version5_3() - Static method in class org.nameapi.client.lib.NameApiPortUrlFactory
versionLatestStable() - Static method in class org.nameapi.client.lib.NameApiPortUrlFactory: This is updated whenever the "latest stable" server api version changes.

W

withContext(String, Context) - Static method in class org.nameapi.client.lib.NameApiModeFactory: Overloaded method that uses: for host: new Host("api.nameapi.org", Protocol.HTTPS) for port url: NameApiPortUrlFactory.versionLatestStable()
withContext(String, Context, Host, RestPortUrlFactory) - Static method in class org.nameapi.client.lib.NameApiModeFactory: You can take this and extend for your setup if you need more.

A B C D E F G H I J M N O P R S T V W
All Classes All Packages