com.speedment.common.codegen.model.trait.HasJavadoc Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
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.common.codegen.model.trait;

import com.speedment.common.codegen.model.Javadoc;

import java.util.Optional;

/**
 * A trait for models that contain {@link Javadoc} components.
 *
 * @param  the extending type
 *
 * @author Emil Forslund
 * @since  2.0
 */
public interface HasJavadoc> {
    
    /**
     * Sets the {@link Javadoc} of this model.
     * 
     * @param doc  the javadoc
     * @return     a reference to this
     */
    T set(final Javadoc doc);

    /**
     * Sets the {@link Javadoc} of this model. This method is a synonym for
     * {@link #set(Javadoc)}.
     *
     * @param doc  the javadoc
     * @return     a reference to this
     *
     * @since 2.5
     */
    default T javadoc(final Javadoc doc) {
        return set(doc);
    }
    
    /**
     * Returns the documentation of this model if such exists, else 
     * empty.
     * 
     * @return  the documentation or empty
     */
    Optional getJavadoc();
}