com.speedment.runtime.config.trait.HasName Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtime-deploy Show documentation
Show all versions of runtime-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is
useful when deploying an application on a server.
/**
*
* Copyright (c) 2006-2017, 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 com.speedment.runtime.config.Project;
import com.speedment.runtime.config.exception.SpeedmentConfigException;
import java.util.Map;
import java.util.Optional;
import static com.speedment.runtime.config.util.TraitUtil.viewOf;
/**
* Trait for {@link Document} implementations that implement the
* {@link #getName()} method. If a {@code Document} implements this trait, it
* is also expected to implement the {@link HasMainInterface} trait.
*
* @author Emil Forslund
* @version 2.3.0
*/
public interface HasName extends Document, HasMainInterface {
/**
* The key of the {@code name} property.
*/
String NAME = "name";
/**
* Gets the name of this Document. If no name is present, this method might
* create a name if the parent implements the {@link HasChildren} interface.
* If it does not and this document is unnamed, an
* {@link SpeedmentConfigException} is called.
*
* @return the name of this Document
* @throws SpeedmentConfigException if no name is specified and the parent can't
* generate one
*/
default String getName() throws SpeedmentConfigException {
final Optional name = getAsString(NAME);
if (name.isPresent()) {
return name.get();
} else if (getParent()
.filter(HasChildren.class::isInstance)
.isPresent()) {
final String defaultName = getParent()
.map(HasChildren.class::cast)
.map(parent -> parent.defaultNameFor(this))
.get();
getData().put(NAME, defaultName);
return defaultName;
} else if (this instanceof Project) {
return Project.class.getSimpleName();
} else {
throw new SpeedmentConfigException(
"A name is required for node of type '" + getClass().getSimpleName() + "'."
);
}
}
/**
* Returns a wrapper of the specified document that implements the
* {@link HasName} trait. If the specified document already implements the
* trait, it is returned unwrapped.
*
* @param document the document to wrap
* @return the wrapper
*/
static HasName of(Document document) {
return viewOf(document, HasName.class, HasNameView::new);
}
}
/**
* A wrapper class that makes sure that a given {@link Document} implements the
* {@link HasName} trait.
*
* @author Emil Forslund
* @since 2.3
*/
class HasNameView extends AbstractTraitView implements HasName {
/**
* Constructs a new name 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
*/
HasNameView(Document parent, Map data, Class mainInterface) {
super(parent, data, mainInterface);
}
}