    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 *     https://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.commons.configuration2.interpol;
    018
    019/**
    020 * <p>
    021 * A simple dummy {@code Lookup} implementation.
    022 * </p>
    023 * <p>
    024 * This implementation always returns <strong>null</strong> for a passed in variable indicating that it cannot resolve that
    025 * variable. This is useful for instance as an application of the <em>null object</em> pattern.
    026 * </p>
    027 * <p>
    028 * This class does not define any state, therefore a single instance can be shared. To enforce usage of only a single
    029 * instance this class is actually an enumeration.
    030 * </p>
    031 *
    032 * @since 2.0
    033 */
    034public enum DummyLookup implements Lookup {
    035    /** The single instance of this class. */
    036    INSTANCE;
    037
    038    /**
    039     * {@inheritDoc} This implementation always returns <strong>null</strong>.
    040     */
    041    @Override
    042    public Object lookup(final String variable) {
    043        return null;
    044    }
    045}