Commentable.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to You 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 org.apache.sling.provisioning.model;

/**
 * A commentable has a comment and a location.
 * Both are optional.
 */
public abstract class Commentable extends Traceable {

    /** The comment. */
    private String comment;

    /**
     * Get the comment.
     * @return The comment or {@code null}.
     */
    public String getComment() {
        return this.comment;
    }

    /**
     * Set the comment.
     * @param value The new comment.
     */
    public void setComment(final String value) {
        this.comment = value;
    }

    @Override
    public String toString() {
        return "Commentable [location=" + this.getLocation() + ", comment=" + comment + "]";
    }
}