View Javadoc
1   /*
2    * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package com.sun.istack.internal.localization;
27  
28  /**
29   * Localizable message.
30   *
31   * @author WS Development Team
32   */
33  public interface Localizable {
34      /**
35       * Gets the key in the resource bundle.
36       *
37       * @return
38       *      if this method returns {@link #NOT_LOCALIZABLE},
39       *      that means the message is not localizable, and
40       *      the first item of {@link #getArguments()} array
41       *      holds a String.
42       */
43      public String getKey();
44  
45      /**
46       * Returns the arguments for message formatting.
47       *
48       * @return
49       *      can be an array of length 0 but never be null.
50       */
51      public Object[] getArguments();
52      public String getResourceBundleName();
53  
54  
55      /**
56       * Special constant that represents a message that
57       * is not localizable.
58       *
59       * <p>
60       * Use of "new" is to create an unique instance.
61       */
62      public static final String NOT_LOCALIZABLE = "\u0000";
63  }