001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.devutils;
018
019import org.apache.wicket.Application;
020import org.apache.wicket.WicketRuntimeException;
021
022/**
023 * Just an exception that can be thrown if a development utility is invoked, constructed, etc, and
024 * the setting in the application is not enabled.
025 * 
026 * Includes a static method that also does this check so that it is not carbon copied throughout the
027 * code.
028 * 
029 * If you see this error in your application, you need to call:
030 * <tt>Application.get().getDebugSettings().setDevelopmentUtilitiesEnabled(true)</tt>
031 * 
032 * @author Jeremy Thomerson
033 */
034public class DevelopmentUtilitiesNotEnabledException extends WicketRuntimeException
035{
036
037        private static final long serialVersionUID = 1L;
038
039        /**
040         * Construct.
041         */
042        public DevelopmentUtilitiesNotEnabledException()
043        {
044                super("IDebugSettings.developmentUtilitiesEnabled must be enabled to use this feature");
045        }
046
047        /**
048         * Verifies that development utilities are enabled.
049         */
050        public static void check()
051        {
052                if (Application.get().getDebugSettings().isDevelopmentUtilitiesEnabled() == false)
053                {
054                        throw new DevelopmentUtilitiesNotEnabledException();
055                }
056        }
057}