cn.taketoday.core.env.Profiles Maven / Gradle / Ivy
/*
* Original Author -> Harry Yang ([email protected]) https://taketoday.cn
* Copyright © TODAY & 2017 - 2021 All Rights Reserved.
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see [http://www.gnu.org/licenses/]
*/
package cn.taketoday.core.env;
import java.util.function.Predicate;
/**
* Profile predicate that may be {@linkplain Environment#acceptsProfiles(Profiles)
* accepted} by an {@link Environment}.
*
* May be implemented directly or, more usually, created using the
* {@link #of(String...) of(...)} factory method.
*
* @author Phillip Webb
* @author Sam Brannen
* @since 4.0
*/
@FunctionalInterface
public interface Profiles {
/**
* Test if this {@code Profiles} instance matches against the given
* active profiles predicate.
*
* @param activeProfiles a predicate that tests whether a given profile is
* currently active
*/
boolean matches(Predicate activeProfiles);
/**
* Create a new {@link Profiles} instance that checks for matches against
* the given profile strings.
* The returned instance will {@linkplain Profiles#matches(Predicate) match}
* if any one of the given profile strings matches.
*
A profile string may contain a simple profile name (for example
* {@code "production"}) or a profile expression. A profile expression allows
* for more complicated profile logic to be expressed, for example
* {@code "production & cloud"}.
*
The following operators are supported in profile expressions.
*
* - {@code !} - A logical NOT of the profile or profile expression
* - {@code &} - A logical AND of the profiles or profile expressions
* - {@code |} - A logical OR of the profiles or profile expressions
*
* Please note that the {@code &} and {@code |} operators may not be mixed
* without using parentheses. For example {@code "a & b | c"} is not a valid
* expression; it must be expressed as {@code "(a & b) | c"} or
* {@code "a & (b | c)"}.
*
Two {@code Profiles} instances returned
* by this method are considered equivalent to each other (in terms of
* {@code equals()} and {@code hashCode()} semantics) if they are created
* with identical profile strings.
*
* @param profiles the profile strings to include
* @return a new {@link Profiles} instance
*/
static Profiles of(String... profiles) {
return ProfilesParser.parse(profiles);
}
}