001/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
002 *
003 * Copyright © 2022 microBean™.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * 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
014 * implied.  See the License for the specific language governing
015 * permissions and limitations under the License.
016 */
017package org.microbean.loader.spi;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Inherited;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * An annotation designating an interface as one that is backed by
028 * various {@link
029 * org.microbean.loader.api.Loader#load(org.microbean.path.Path)
030 * Loader.load(Path)} calls, and that informs any {@link Provider}
031 * implementation that wishes to proxy it that the interface in
032 * question may be proxied.
033 *
034 * @author <a href="https://about.me/lairdnelson"
035 * target="_parent">Laird Nelson</a>
036 *
037 * @see org.microbean.loader.ProxyingProvider
038 */
039@Documented
040@Inherited
041@Retention(RetentionPolicy.RUNTIME)
042@Target({ ElementType.TYPE, ElementType.METHOD })
043public @interface LoaderFacade {
044
045  /**
046   * Whether the annotated element may be proxied or not.
047   *
048   * @return {@code true} if the annotated element may be proxied
049   */
050  boolean value() default true;
051  
052}