001/*
002 *   Copyright 2024 Vonage
003 *
004 *   Licensed under the Apache License, Version 2.0 (the "License");
005 *   you may not use this file except in compliance with the License.
006 *   You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *   Unless required by applicable law or agreed to in writing, software
011 *   distributed under the License is distributed on an "AS IS" BASIS,
012 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *   See the License for the specific language governing permissions and
014 *   limitations under the License.
015 */
016package com.vonage.client.numbers;
017
018import com.fasterxml.jackson.annotation.JsonValue;
019
020/**
021 * Provided to calls that match substrings, to indicate which part of the string should be considered a match.
022 */
023public enum SearchPattern {
024    /**
025     * Search for numbers that start with the pattern (Note: all numbers are in E.164 format,
026     * so the starting pattern includes the country code, such as 1 for USA).
027     */
028    STARTS_WITH(0),
029
030    /**
031     * Search for numbers that contain the pattern.
032     */
033    ANYWHERE(1),
034
035    /**
036     * Search for numbers that end with the pattern.
037     */
038    ENDS_WITH(2);
039
040    private final int value;
041
042    SearchPattern(int value) {
043        this.value = value;
044    }
045
046    @JsonValue
047    public int getValue() {
048        return value;
049    }
050}