org.shredzone.commons.view.PathContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-view Show documentation

Shredzone Commons: Enhanced Spring Views

The newest version!

/*
 * Shredzone Commons
 *
 * Copyright (C) 2012 Richard "Shred" Körber
 *   http://commons.shredzone.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Library General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this program.  If not, see .
 */

package org.shredzone.commons.view;

import java.util.Map;

import javax.annotation.Nonnull;
import javax.annotation.ParametersAreNonnullByDefault;

/**
 * Context that holds all data required for building a path.
 *
 * @author Richard "Shred" Körber
 */
@ParametersAreNonnullByDefault
public interface PathContext {

    /**
     * Gets a {@link Signature} for this {@link PathContext}.
     *
     * @return {@link Signature} object
     */
    @Nonnull Signature getSignature();

    /**
     * Gets the qualifier to be used.
     *
     * @return qualifier, or {@code null} for the standard qualifier
     */
    String getQualifier();

    /**
     * Gets a map of variables to be used.
     *
     * @return map of variables
     */
    @Nonnull Map getVariables();

}