com.speedment.common.codegen.model.Javadoc Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of generator-deploy Show documentation
Show all versions of generator-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.common.codegen.model;
import com.speedment.common.codegen.internal.model.JavadocImpl;
import com.speedment.common.codegen.model.trait.HasCall;
import com.speedment.common.codegen.model.trait.HasCopy;
import com.speedment.common.codegen.model.trait.HasImports;
import com.speedment.common.codegen.model.trait.HasJavadoc;
import com.speedment.common.codegen.model.trait.HasJavadocTags;
import com.speedment.common.codegen.model.trait.HasParent;
/**
* A model that represents a block of documentation in code.
*
* @author Emil Forslund
* @see JavadocTag
* @since 2.0
*/
public interface Javadoc
extends HasParent, Javadoc>,
HasImports,
HasCopy,
HasCall,
HasJavadocTags {
/**
* Sets the body text shown in the javadoc.
*
* @param text the text
* @return a reference to this model
*/
Javadoc setText(String text);
/**
* Returns the body text shown in the javadoc.
*
* @return the body documentation text
*/
String getText();
/**
* Creates a new instance implementing this interface by using the default
* implementation.
* @return the new instance
*/
static Javadoc of() {
return new JavadocImpl();
}
/**
* Creates a new instance implementing this interface by using the default
* implementation.
*
* @param text the documentation
* @return the new instance
*/
static Javadoc of(String text) {
return of().setText(text);
}
}