/*
 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.istack.internal;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;

Designates that a field, return value, argument, or a variable is supposed to be an interned string. 

In many places in the istack, we assume Strings to be interned for
the performance reason. Similarly, In many other places, we don't
make such an assumption for the performance reason (because intern
isn't free.)

Therefore, distinguishing which part is supposed to be interned and
which part is supposed to be not is important. This annotation
allows us to capture that in the code.
Author:
Kohsuke Kawaguchi/**
 * Designates that a field, return value, argument, or a variable is supposed
 * to be an {@link String#intern() interned} string.
 *
 * <p>
 * In many places in the istack, we assume Strings to be interned for
 * the performance reason. Similarly, In many other places, we don't
 * make such an assumption for the performance reason (because intern
 * isn't free.)
 *
 * <p>
 * Therefore, distinguishing which part is supposed to be interned and
 * which part is supposed to be not is important. This annotation
 * allows us to capture that in the code.
 *
 * @author Kohsuke Kawaguchi
 */
@Documented
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.FIELD,ElementType.METHOD,ElementType.PARAMETER,ElementType.LOCAL_VARIABLE})
public @interface Interned {
}