AbstractRoute.java

/*
 * Copyright 2011- Per Wendel
 *
 *  Licensed 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 spark;

import spark.HaltException;

/**
 * Functionality used in both Route and Filter
 *
 * @author Per Wendel
 */
public abstract class AbstractRoute {

    /**
     * Immediately stops a request within a filter or route
     * NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise
     * halt will not work
     */
    protected static final void halt() {
        throw new HaltException();
    }
    
    /**
     * Immediately stops a request within a filter or route with specified status code
     * NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise
     * halt will not work
     * 
     * @param status the status code
     */
    protected static final void halt(int status) {
        throw new HaltException(status);
    }
    
    /**
     * Immediately stops a request within a filter or route with specified body content
     * NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise
     * halt will not work
     * 
     * @param body The body content
     */
    protected static final void halt(String body) {
        throw new HaltException(body);
    }
    
    /**
     * Immediately stops a request within a filter or route with specified status code and body content
     * NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise
     * halt will not work
     * 
     * @param status The status code
     * @param body The body content
     */
    protected static final void halt(int status, String body) {
        throw new HaltException(status, body);
    }
    
}