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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of codegen Show documentation

An object-oriented code generator for Java that is built using the Model-View-Controller (MVC) design philosophy.

There is a newer version: 3.2.10

/**
 *
 * 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 java.util.Optional;

/**
 * A trait for models that can have a comment.
 * 
 * @author Emil Forslund
 * @param  The extending type
 * @since  2.0
 */
public interface HasComment> {
    
    /**
     * If a comment is attached to this model, return it. Else empty.
     * 
     * @return  the comment or empty
     */
	Optional getComment();
    
    /**
     * Sets the comment of this model. The comment may have multiple rows.
     * 
     * @param comment  the comment
     * @return         a reference to this
     */
	T setComment(String comment);
}