org.apache.openjpa.lib.xml.Commentable Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openjpa-all

There is a newer version: 4.0.0

/*
 * 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.openjpa.lib.xml;

/**
 * Implementations of this interface can be adorned with comments.
 *
 * @nojavadoc
 * @since 0.3.3
 */
public interface Commentable {

    public static final String[] EMPTY_COMMENTS = new String[0];

    /**
     * Set comments.
     */
    public void setComments(String[] comments);

    /**
     * Return comments, or empty array if none.
     */
    public String[] getComments();
}