001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.origin;
018
019/**
020 * Interface to provide access to the origin of an item.
021 *
022 * @author Phillip Webb
023 * @since 2.0.0
024 * @see Origin
025 */
026@FunctionalInterface
027public interface OriginProvider {
028
029        /**
030         * Return the source origin or {@code null} if the origin is not known.
031         * @return the origin or {@code null}
032         */
033        Origin getOrigin();
034
035}