org.glassfish.jersey.server.model.ResourceModelVisitor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jersey-server Show documentation
Jersey core server implementation
There is a newer version: 4.0.0-M1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2013 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.glassfish.jersey.server.model;

/**
 * Following the visitor pattern, this interface allows implementing processors
 * traversing all abstract model components present in a given model.
 *
 * @see ResourceModelComponent
 *
 * @author Jakub Podlesak (jakub.podlesak at oracle.com)
 * @author Marek Potociar (marek.potociar at oracle.com)
 */
public interface ResourceModelVisitor {

    /**
     * Start visiting a single resource model.
     *
     * @param resource resource model.
     */
    void visitResource(Resource resource);

    /**
     *  Start visiting a single child resource model.
     * @param resource child resource model.
     */
    void visitChildResource(Resource resource);

    /**
     * Visit a single resource method model.
     *
     * @param method resource method model.
     */
    void visitResourceMethod(ResourceMethod method);

    /**
     * Visit a single resource method invocable model.
     *
     * @param invocable resource method invocable model.
     */
    void visitInvocable(Invocable invocable);

    /**
     * Visit a single resource method handler model.
     *
     * @param methodHandler resource method handler model.
     */
    void visitMethodHandler(MethodHandler methodHandler);

    /**
     * Process a resource method handler constructor.
     *
     * Typically a constructor of a JAX-RS annotated resource class.
     *
     * @param constructor resource method handler constructor.
     */
    void visitResourceHandlerConstructor(HandlerConstructor constructor);

    /**
     * Process a resource model.
     *
     * @param resourceModel resource model.
     */
    void visitResourceModel(ResourceModel resourceModel);

    /**
     * Process a runtime resource model.
     * @param runtimeResource runtime resource model.
     */
    void visitRuntimeResource(RuntimeResource runtimeResource);
}