com.speedment.runtime.config.trait.HasEnabled Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation
Show all versions of tool-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is
useful when deploying an application on a server.
The newest version!
/*
*
* Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
*
* 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 com.speedment.runtime.config.trait;
import com.speedment.runtime.config.Document;
import java.util.Map;
import static com.speedment.runtime.config.util.TraitUtil.viewOf;
/**
* Trait for {@link Document} implementations that implement the
* {@link #isEnabled()} method.
*
* @author Emil Forslund
* @since 2.3.0
*/
public interface HasEnabled extends Document {
/**
* Returns if this document is enabled. The alias is a boolean value located
* under the {@link HasEnableUtil#ENABLED} key.
*
* @return {@code true} if enabled, else {@code false}
*/
default boolean isEnabled() {
return getAsBoolean(HasEnableUtil.ENABLED).orElse(HasEnableUtil.ENABLED_DEFAULT);
}
/**
* Returns {@code true} if the specified {@link Document} should be
* considered {@code enabled}, else {@code false}.
*
* @param doc the document to test
* @return {@code true} if enabled, else {@code false}
*/
static boolean test(Document doc) {
return of(doc).isEnabled();
}
/**
* Returns a wrapper of the specified document that implements the
* {@link HasEnabled} trait. If the specified document already implements the
* trait, it is returned unwrapped.
*
* @param document the document to wrap
* @return the wrapper
*/
static HasEnabled of(Document document) {
return viewOf(document, HasEnabled.class, HasEnabledView::new);
}
}
/**
* A wrapper class that makes sure that a given {@link Document} implements the
* {@link HasEnabled} trait.
*
* @author Emil Forslund
* @since 2.3
*/
class HasEnabledView extends AbstractTraitView implements HasEnabled {
/**
* Constructs a new enabled view of with the specified parent and data.
*
* @param parent the parent of the wrapped document
* @param data the data of the wrapped document
* @param mainInterface the main interface of the wrapped document
*/
HasEnabledView(Document parent, Map data, Class mainInterface) {
super(parent, data, mainInterface);
}
}