/*
* Copyright 2002-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 org.springframework.core.env;
import java.util.function.Predicate;
Profile predicate that may be
accepted by an Environment
. May be implemented directly or, more usually, created using the of(...)
factory method.
Author: Phillip Webb Since: 5.1
/**
* Profile predicate that may be {@linkplain Environment#acceptsProfiles(Profiles)
* accepted} by an {@link Environment}.
*
* <p>May be implemented directly or, more usually, created using the
* {@link #of(String...) of(...)} factory method.
*
* @author Phillip Webb
* @since 5.1
*/
@FunctionalInterface
public interface Profiles {
Test if this Profiles
instance matches against the given
active profiles predicate.
Params: - activeProfiles – predicate that tests whether a given profile is
currently active
/**
* Test if this {@code Profiles} instance <em>matches</em> against the given
* active profiles predicate.
* @param activeProfiles predicate that tests whether a given profile is
* currently active
*/
boolean matches(Predicate<String> activeProfiles);
Create a new Profiles
instance that checks for matches against the given profile strings.
The returned instance will match if any one of the given profile strings matches.
A profile string may contain a simple profile name (for example "production"
) or a profile expression. A profile expression allows for more complicated profile logic to be expressed, for example "production & cloud"
.
The following operators are supported in profile expressions:
!
- A logical not of the profile
&
- A logical and of the profiles
|
- A logical or of the profiles
Please note that the &
and |
operators may not be mixed without using parentheses. For example "a & b | c"
is not a valid expression; it must be expressed as "(a & b) | c"
or "a & (b | c)"
.
Params: - profiles – the profile strings to include
Returns: a new Profiles
instance
/**
* Create a new {@link Profiles} instance that checks for matches against
* the given <em>profile strings</em>.
* <p>The returned instance will {@linkplain Profiles#matches(Predicate) match}
* if any one of the given profile strings matches.
* <p>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"}.
* <p>The following operators are supported in profile expressions:
* <ul>
* <li>{@code !} - A logical <em>not</em> of the profile</li>
* <li>{@code &} - A logical <em>and</em> of the profiles</li>
* <li>{@code |} - A logical <em>or</em> of the profiles</li>
* </ul>
* <p>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)"}.
* @param profiles the <em>profile strings</em> to include
* @return a new {@link Profiles} instance
*/
static Profiles of(String... profiles) {
return ProfilesParser.parse(profiles);
}
}