io.undertow.predicate.PredicateBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

The newest version!

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2014 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * 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 io.undertow.predicate;

import java.util.Map;
import java.util.Set;

/**
 * An interface that knows how to build a predicate from a textual representation. This is loaded
 * using a service loader to make it configurable.
 * 
 * This makes it easy to configure conditions based on a string representation
 *
 * @author Stuart Douglas
 */
public interface PredicateBuilder {

    /**
     * The string representation of the predicate name.
     *
     * @return The predicate name
     */
    String name();

    /**
     * Returns a map of parameters and their types.
     */
    Map> parameters();

    /**
     *
     * @return The required parameters
     */
    Set requiredParameters();

    /**
     * @return The default parameter name, or null if it does not have a default parameter
     */
    String defaultParameter();

    /**
     * Creates a predicate
     *
     * @param config The predicate config
     * @return The new predicate
     */
    Predicate build(final Map config);

}