001/*
002 * Copyright (c) 2004-2010, Kohsuke Kawaguchi
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification, are permitted provided
006 * that the following conditions are met:
007 *
008 *     * Redistributions of source code must retain the above copyright notice, this list of
009 *       conditions and the following disclaimer.
010 *     * Redistributions in binary form must reproduce the above copyright notice, this list of
011 *       conditions and the following disclaimer in the documentation and/or other materials
012 *       provided with the distribution.
013 *
014 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
015 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
016 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
017 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
018 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
019 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
020 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
021 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
022 */
023
024package org.kohsuke.stapler.jelly;
025
026import java.lang.annotation.Documented;
027import java.lang.annotation.Retention;
028import java.lang.annotation.Target;
029
030import static java.lang.annotation.ElementType.TYPE;
031import static java.lang.annotation.RetentionPolicy.RUNTIME;
032
033/**
034 * Indicates that concrete subtypes must have the views of the specified names.
035 * For example, if your abstract class defines a mandatory view "foo.jelly", write
036 * {@code @RequiresView("foo.jelly")}.
037 *
038 * <p>
039 * TODO: write a checker that makes sure all the subtypes have required views.
040 * I initially tried to do this in {@link AnnotationProcessorImpl}, but they don't see
041 * resources, so the check needs to be done much later, probably by inspecting the jar file.
042 *
043 * @author Kohsuke Kawaguchi
044 */
045@Documented
046@Retention(RUNTIME)
047@Target(TYPE)
048public @interface RequiresView {
049    /**
050     * Names of the view that's required.
051     */
052    String[] value();
053}