001/*
002 * Copyright 2008-2014 UnboundID Corp.
003 * All Rights Reserved.
004 */
005/*
006 * Copyright (C) 2008-2014 UnboundID Corp.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU General Public License (GPLv2 only)
010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011 * as published by the Free Software Foundation.
012 *
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Public License for more details.
017 *
018 * You should have received a copy of the GNU General Public License
019 * along with this program; if not, see <http://www.gnu.org/licenses>.
020 */
021package com.unboundid.util;
022
023
024
025import java.lang.annotation.Documented;
026import java.lang.annotation.ElementType;
027import java.lang.annotation.Retention;
028import java.lang.annotation.RetentionPolicy;
029import java.lang.annotation.Target;
030
031
032
033/**
034 * This annotation type, may be used to mark a class, constructor, or method
035 * that is part of the LDAP SDK codebase to be for internal use only, and
036 * therefore something that should not be accessed by third-party code.  If a
037 * class is marked with the {@code @InternalUseOnly} annotation, then no part of
038 * that class should be used by third-party code.  If a class is not marked with
039 * the {@code @InternalUseOnly} annotation, then it may be assumed that the
040 * class is part of the public API, and any public constructors and methods
041 * which do not have the {@code @InternalUseOnly} annotation may be used by
042 * third-party code.
043 */
044@Documented()
045@Retention(RetentionPolicy.RUNTIME)
046@Target({ ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.METHOD,
047          ElementType.PACKAGE })
048public @interface InternalUseOnly
049{
050}