org.springframework.core.env.Profiles Maven / Gradle / Ivy
/*
* Copyright 2002-2023 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
*
* https://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 org.springframework.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 5.1
*/
@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 expressions.
* The returned instance will {@linkplain Profiles#matches(Predicate) match}
* if any one of the given profile expressions matches.
*
A profile expression may contain a simple profile name (for example
* {@code "production"}) or a compound expression. A compound 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 name or compound expression
* - {@code &} - A logical AND of the profile names or compound expressions
* - {@code |} - A logical OR of the profile names or compound 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)"}.
*
As of Spring Framework 5.1.17, 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 expressions.
* @param profileExpressions the profile expressions to include
* @return a new {@link Profiles} instance
*/
static Profiles of(String... profileExpressions) {
return ProfilesParser.parse(profileExpressions);
}
}