org.xwiki.blame.AnnotatedElement Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-blame-api Show documentation

API to produce blame/annotate/praise information from a history of changes

There is a newer version: 16.8.0-rc-1

Show newest version

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.xwiki.blame;

/**
 * Single element of an annotated content.
 *
 * @param  type of the revision object that old metadata about the revision.
 * @param  type of the element to annotate (ie: String holding a line).
 * @version $Id: 5247beb49e7a28cb0e68414cfc0a6d3b1a76b399 $
 * @since 6.2M2
 */
public interface AnnotatedElement
{
    /**
     * @return the element (ie: a single line).
     */
    E getElement();

    /**
     * @return the metadata of the source revision of this element or null if this information has not yet been found.
     */
    R getRevision();
}