jmms.testing.fake.Faker Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package jmms.testing.fake;

public interface Faker {

    /**
     * Returns the key matches the category and name exactly.
     */
    String matches(String category, String name);

    /**
     * Generates the fake value of the given key.
     */
    default Object fake(String key){
        return fake(key, FakeOptions.NO_OPTS);
    }

    /**
     * Generates the fake value of the given key.
     */
    Object fake(String key, FakeOptions opts);

    /**
     * Returns null if the key not exists.
     */
    default Object tryFake(String key) {
        return tryFake(key, FakeOptions.NO_OPTS);
    }

    Object tryFake(String key, FakeOptions opts);

    /**
     * Parse and eval the expression.
     */
    String eval(String expr);

    /**
     * Fake data by regex.
     */
    default String regex(String pattern) {
        return regex(pattern, FakeOptions.NO_OPTS);
    }

    /**
     * Fake data by regex.
     */
    String regex(String pattern, FakeOptions opts);
}