blob: e767afcdd3e29ce81c481c7f0434b6d15b6c164f [file] [log] [blame]
/*
* Copyright (C) 2006 The Guava Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.common.annotations;
/**
* Annotates a program element that exists, or is more widely visible than otherwise necessary, only
* for use in test code.
*
* <p><b>Do not use this interface</b> for public or protected declarations: it is a fig leaf for
* bad design, and it does not prevent anyone from using the declaration---and experience has shown
* that they will. If the method breaks the encapsulation of its class, then its internal
* representation will be hard to change. Instead, use <a
* href="http://errorprone.info/bugpattern/RestrictedApiChecker">RestrictedApiChecker</a>, which
* enforces fine-grained visibility policies.
*
* @author Johannes Henkel
*/
@GwtCompatible
public @interface VisibleForTesting {
}