apidocs/org/apache/calcite/runtime/Resources.ShadowResourceBundle.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>Resources.ShadowResourceBundle (Apache Calcite API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="Resources.ShadowResourceBundle (Apache Calcite API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":10,"i1":10,"i2":9,"i3":9};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 var pathtoroot = "../../../../";
 var useModuleDirectories = true;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/Resources.ShadowResourceBundle.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <ul class="navListSearch">
 <li><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.runtime</a></div>
 <h2 title="Class Resources.ShadowResourceBundle" class="title">Class Resources.ShadowResourceBundle</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li>java.util.ResourceBundle</li>
 <li>
 <ul class="inheritance">
 <li>org.apache.calcite.runtime.Resources.ShadowResourceBundle</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>Enclosing class:</dt>
 <dd><a href="Resources.html" title="class in org.apache.calcite.runtime">Resources</a></dd>
 </dl>
 <hr>
 <pre>public abstract static class <span class="typeNameLabel">Resources.ShadowResourceBundle</span>
 extends java.util.ResourceBundle</pre>
 <div class="block"><code>ShadowResourceBundle</code> is an abstract base class for
  <code>ResourceBundle</code> classes which are backed by a properties file. When
  the class is created, it loads a properties file with the same name as the
  class.

  <p> In the standard scheme (see <code>ResourceBundle</code>), if
  you call <code><code>ResourceBundle.getBundle(java.lang.String)</code>("foo.MyResource")</code>,
  it first looks for a class called <code>foo.MyResource</code>, then
  looks for a file called <code>foo/MyResource.properties</code>. If it finds
  the file, it creates a <code>PropertyResourceBundle</code> and loads the class.
  The problem is if you want to load the <code>.properties</code> file
  into a dedicated class; <code>ShadowResourceBundle</code> helps with this
  case.

  <p> You should create a class as follows:<blockquote>

  <pre>package foo;
 class MyResource extends ShadowResourceBundle {
     public MyResource() throws java.io.IOException {
     }
 }</pre>

  </blockquote>

  Then when you call
  <code>ResourceBundle.getBundle("foo.MyResource")</code>,
  it will find the class before the properties file, but still automatically
  load the properties file based upon the name of the class.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="nested.class.summary">
 <!--   -->
 </a>
 <h3>Nested Class Summary</h3>
 <ul class="blockList">
 <li class="blockList"><a id="nested.classes.inherited.from.class.java.util.ResourceBundle">
 <!--   -->
 </a>
 <h3>Nested classes/interfaces inherited from class&nbsp;java.util.ResourceBundle</h3>
 <code>java.util.ResourceBundle.Control</code></li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- =========== FIELD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="memberSummary">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Field</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>private java.util.PropertyResourceBundle</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bundle">bundle</a></span></code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="fields.inherited.from.class.java.util.ResourceBundle">
 <!--   -->
 </a>
 <h3>Fields inherited from class&nbsp;java.util.ResourceBundle</h3>
 <code>parent</code></li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier</th>
 <th class="colSecond" scope="col">Constructor</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected </code></td>
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ShadowResourceBundle</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Creates a <code>ShadowResourceBundle</code>, and reads resources from
  a <code>.properties</code> file with the same name as the current class.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>java.util.Enumeration&lt;java.lang.String&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeys()">getKeys</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>protected java.lang.Object</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleGetObject(java.lang.String)">handleGetObject</a></span>&#8203;(java.lang.String&nbsp;key)</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>protected static <a href="Resources.ShadowResourceBundle.html" title="class in org.apache.calcite.runtime">Resources.ShadowResourceBundle</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#instance(java.lang.String,java.util.Locale,java.util.ResourceBundle)">instance</a></span>&#8203;(java.lang.String&nbsp;baseName,
         java.util.Locale&nbsp;locale,
         java.util.ResourceBundle&nbsp;bundle)</code></th>
 <td class="colLast">
 <div class="block">Returns the instance of the <code>baseName</code> resource bundle
  for the given locale.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>private static java.io.InputStream</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openPropertiesFile(java.lang.Class)">openPropertiesFile</a></span>&#8203;(java.lang.Class&nbsp;clazz)</code></th>
 <td class="colLast">
 <div class="block">Opens the properties file corresponding to a given class.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.java.util.ResourceBundle">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.util.ResourceBundle</h3>
 <code>clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getLocale, getObject, getString, getStringArray, handleKeySet, keySet, setParent</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a id="bundle">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>bundle</h4>
 <pre>private&nbsp;java.util.PropertyResourceBundle bundle</pre>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a id="&lt;init&gt;()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>ShadowResourceBundle</h4>
 <pre>protected&nbsp;ShadowResourceBundle()
                         throws java.io.IOException</pre>
 <div class="block">Creates a <code>ShadowResourceBundle</code>, and reads resources from
  a <code>.properties</code> file with the same name as the current class.
  For example, if the class is called <code>foo.MyResource_en_US</code>,
  reads from <code>foo/MyResource_en_US.properties</code>, then
  <code>foo/MyResource_en.properties</code>, then
  <code>foo/MyResource.properties</code>.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code>java.io.IOException</code> - on error</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="openPropertiesFile(java.lang.Class)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>openPropertiesFile</h4>
 <pre class="methodSignature">private static&nbsp;java.io.InputStream&nbsp;openPropertiesFile&#8203;(java.lang.Class&nbsp;clazz)</pre>
 <div class="block">Opens the properties file corresponding to a given class. The code is
  copied from <code>ResourceBundle</code>.</div>
 </li>
 </ul>
 <a id="getKeys()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getKeys</h4>
 <pre class="methodSignature">public&nbsp;java.util.Enumeration&lt;java.lang.String&gt;&nbsp;getKeys()</pre>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code>getKeys</code>&nbsp;in class&nbsp;<code>java.util.ResourceBundle</code></dd>
 </dl>
 </li>
 </ul>
 <a id="handleGetObject(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>handleGetObject</h4>
 <pre class="methodSignature">protected&nbsp;java.lang.Object&nbsp;handleGetObject&#8203;(java.lang.String&nbsp;key)</pre>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code>handleGetObject</code>&nbsp;in class&nbsp;<code>java.util.ResourceBundle</code></dd>
 </dl>
 </li>
 </ul>
 <a id="instance(java.lang.String,java.util.Locale,java.util.ResourceBundle)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>instance</h4>
 <pre class="methodSignature">protected static&nbsp;<a href="Resources.ShadowResourceBundle.html" title="class in org.apache.calcite.runtime">Resources.ShadowResourceBundle</a>&nbsp;instance&#8203;(java.lang.String&nbsp;baseName,
                                                          java.util.Locale&nbsp;locale,
                                                          java.util.ResourceBundle&nbsp;bundle)</pre>
 <div class="block">Returns the instance of the <code>baseName</code> resource bundle
  for the given locale.

  <p> This method should be called from a derived class, with the proper
  casting:<blockquote>

  <pre>class MyResource extends ShadowResourceBundle {
     ...

     /&#42;&#42;
       &#42; Retrieves the instance of {&#64;link MyResource} appropriate
       &#42; to the given locale.
       &#42;&#42;/
     public static MyResource instance(Locale locale) {
        return (MyResource) instance(
            MyResource.class.getName(), locale,
            ResourceBundle.getBundle(MyResource.class.getName(), locale));
     }
     ...
  }</pre></blockquote></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>baseName</code> - Base name</dd>
 <dd><code>locale</code> - Locale</dd>
 <dd><code>bundle</code> - Resource bundle</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>Resource bundle</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/Resources.ShadowResourceBundle.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc -->
	<title>Resources.ShadowResourceBundle (Apache Calcite API)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
	<script type="text/javascript" src="../../../../script.js"></script>
	<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
	<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
	<!--[if IE]>
	<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
	<![endif]-->
	<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
	<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
	<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="Resources.ShadowResourceBundle (Apache Calcite API)";
	}
	}
	catch(err) {
	}
	//-->
	var data = {"i0":10,"i1":10,"i2":9,"i3":9};
	var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
	var altColor = "altColor";
	var rowColor = "rowColor";
	var tableTab = "tableTab";
	var activeTableTab = "activeTableTab";
	var pathtoroot = "../../../../";
	var useModuleDirectories = true;
	loadScripts(document, 'script');</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<header role="banner">
	<nav role="navigation">
	<div class="fixedNav">
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a id="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/Resources.ShadowResourceBundle.html">Use</a></li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../index-all.html">Index</a></li>
	<li><a href="../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList" id="allclasses_navbar_top">
	<li><a href="../../../../allclasses.html">All Classes</a></li>
	</ul>
	<ul class="navListSearch">
	<li><label for="search">SEARCH:</label>
	<input type="text" id="search" value="search" disabled="disabled">
	<input type="reset" id="reset" value="reset" disabled="disabled">
	</li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_top");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li><a href="#nested.class.summary">Nested</a> \| </li>
	<li><a href="#field.summary">Field</a> \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li><a href="#field.detail">Field</a> \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<a id="skip.navbar.top">
	<!-- -->
	</a></div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	</div>
	<div class="navPadding"> </div>
	<script type="text/javascript"><!--
	$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
	//-->
	</script>
	</nav>
	</header>
	<!-- ======== START OF CLASS DATA ======== -->
	<main role="main">
	<div class="header">
	<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.runtime</a></div>
	<h2 title="Class Resources.ShadowResourceBundle" class="title">Class Resources.ShadowResourceBundle</h2>
	</div>
	<div class="contentContainer">
	<ul class="inheritance">
	<li>java.lang.Object</li>
	<li>
	<ul class="inheritance">
	<li>java.util.ResourceBundle</li>
	<li>
	<ul class="inheritance">
	<li>org.apache.calcite.runtime.Resources.ShadowResourceBundle</li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<dl>
	<dt>Enclosing class:</dt>
	<dd><a href="Resources.html" title="class in org.apache.calcite.runtime">Resources</a></dd>
	</dl>
	<hr>
	<pre>public abstract static class <span class="typeNameLabel">Resources.ShadowResourceBundle</span>
	extends java.util.ResourceBundle</pre>
	<div class="block"><code>ShadowResourceBundle</code> is an abstract base class for
	<code>ResourceBundle</code> classes which are backed by a properties file. When
	the class is created, it loads a properties file with the same name as the
	class.

	<p> In the standard scheme (see <code>ResourceBundle</code>), if
	you call <code><code>ResourceBundle.getBundle(java.lang.String)</code>("foo.MyResource")</code>,
	it first looks for a class called <code>foo.MyResource</code>, then
	looks for a file called <code>foo/MyResource.properties</code>. If it finds
	the file, it creates a <code>PropertyResourceBundle</code> and loads the class.
	The problem is if you want to load the <code>.properties</code> file
	into a dedicated class; <code>ShadowResourceBundle</code> helps with this
	case.

	<p> You should create a class as follows:<blockquote>

	<pre>package foo;
	class MyResource extends ShadowResourceBundle {
	public MyResource() throws java.io.IOException {
	}
	}</pre>

	</blockquote>

	Then when you call
	<code>ResourceBundle.getBundle("foo.MyResource")</code>,
	it will find the class before the properties file, but still automatically
	load the properties file based upon the name of the class.</div>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- ======== NESTED CLASS SUMMARY ======== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="nested.class.summary">
	<!-- -->
	</a>
	<h3>Nested Class Summary</h3>
	<ul class="blockList">
	<li class="blockList"><a id="nested.classes.inherited.from.class.java.util.ResourceBundle">
	<!-- -->
	</a>
	<h3>Nested classes/interfaces inherited from class java.util.ResourceBundle</h3>
	<code>java.util.ResourceBundle.Control</code></li>
	</ul>
	</li>
	</ul>
	</section>
	<!-- =========== FIELD SUMMARY =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="field.summary">
	<!-- -->
	</a>
	<h3>Field Summary</h3>
	<table class="memberSummary">
	<caption><span>Fields</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colSecond" scope="col">Field</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>private java.util.PropertyResourceBundle</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bundle">bundle</a></span></code></th>
	<td class="colLast"> </td>
	</tr>
	</table>
	<ul class="blockList">
	<li class="blockList"><a id="fields.inherited.from.class.java.util.ResourceBundle">
	<!-- -->
	</a>
	<h3>Fields inherited from class java.util.ResourceBundle</h3>
	<code>parent</code></li>
	</ul>
	</li>
	</ul>
	</section>
	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="constructor.summary">
	<!-- -->
	</a>
	<h3>Constructor Summary</h3>
	<table class="memberSummary">
	<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier</th>
	<th class="colSecond" scope="col">Constructor</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>protected </code></td>
	<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ShadowResourceBundle</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Creates a <code>ShadowResourceBundle</code>, and reads resources from
	a <code>.properties</code> file with the same name as the current class.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</section>
	<!-- ========== METHOD SUMMARY =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="method.summary">
	<!-- -->
	</a>
	<h3>Method Summary</h3>
	<table class="memberSummary">
	<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colSecond" scope="col">Method</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	<tr id="i0" class="altColor">
	<td class="colFirst"><code>java.util.Enumeration<java.lang.String></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeys()">getKeys</a></span>()</code></th>
	<td class="colLast"> </td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code>protected java.lang.Object</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleGetObject(java.lang.String)">handleGetObject</a></span>(java.lang.String key)</code></th>
	<td class="colLast"> </td>
	</tr>
	<tr id="i2" class="altColor">
	<td class="colFirst"><code>protected static <a href="Resources.ShadowResourceBundle.html" title="class in org.apache.calcite.runtime">Resources.ShadowResourceBundle</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#instance(java.lang.String,java.util.Locale,java.util.ResourceBundle)">instance</a></span>(java.lang.String baseName,
	java.util.Locale locale,
	java.util.ResourceBundle bundle)</code></th>
	<td class="colLast">
	<div class="block">Returns the instance of the <code>baseName</code> resource bundle
	for the given locale.</div>
	</td>
	</tr>
	<tr id="i3" class="rowColor">
	<td class="colFirst"><code>private static java.io.InputStream</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openPropertiesFile(java.lang.Class)">openPropertiesFile</a></span>(java.lang.Class clazz)</code></th>
	<td class="colLast">
	<div class="block">Opens the properties file corresponding to a given class.</div>
	</td>
	</tr>
	</table>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.java.util.ResourceBundle">
	<!-- -->
	</a>
	<h3>Methods inherited from class java.util.ResourceBundle</h3>
	<code>clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getLocale, getObject, getString, getStringArray, handleKeySet, keySet, setParent</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
	<!-- -->
	</a>
	<h3>Methods inherited from class java.lang.Object</h3>
	<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
	</ul>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ FIELD DETAIL =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="field.detail">
	<!-- -->
	</a>
	<h3>Field Detail</h3>
	<a id="bundle">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>bundle</h4>
	<pre>private java.util.PropertyResourceBundle bundle</pre>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	<!-- ========= CONSTRUCTOR DETAIL ======== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="constructor.detail">
	<!-- -->
	</a>
	<h3>Constructor Detail</h3>
	<a id="<init>()">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>ShadowResourceBundle</h4>
	<pre>protected ShadowResourceBundle()
	throws java.io.IOException</pre>
	<div class="block">Creates a <code>ShadowResourceBundle</code>, and reads resources from
	a <code>.properties</code> file with the same name as the current class.
	For example, if the class is called <code>foo.MyResource_en_US</code>,
	reads from <code>foo/MyResource_en_US.properties</code>, then
	<code>foo/MyResource_en.properties</code>, then
	<code>foo/MyResource.properties</code>.</div>
	<dl>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code>java.io.IOException</code> - on error</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	<!-- ============ METHOD DETAIL ========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a id="openPropertiesFile(java.lang.Class)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>openPropertiesFile</h4>
	<pre class="methodSignature">private static java.io.InputStream openPropertiesFile(java.lang.Class clazz)</pre>
	<div class="block">Opens the properties file corresponding to a given class. The code is
	copied from <code>ResourceBundle</code>.</div>
	</li>
	</ul>
	<a id="getKeys()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getKeys</h4>
	<pre class="methodSignature">public java.util.Enumeration<java.lang.String> getKeys()</pre>
	<dl>
	<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
	<dd><code>getKeys</code> in class <code>java.util.ResourceBundle</code></dd>
	</dl>
	</li>
	</ul>
	<a id="handleGetObject(java.lang.String)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>handleGetObject</h4>
	<pre class="methodSignature">protected java.lang.Object handleGetObject(java.lang.String key)</pre>
	<dl>
	<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
	<dd><code>handleGetObject</code> in class <code>java.util.ResourceBundle</code></dd>
	</dl>
	</li>
	</ul>
	<a id="instance(java.lang.String,java.util.Locale,java.util.ResourceBundle)">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>instance</h4>
	<pre class="methodSignature">protected static <a href="Resources.ShadowResourceBundle.html" title="class in org.apache.calcite.runtime">Resources.ShadowResourceBundle</a> instance(java.lang.String baseName,
	java.util.Locale locale,
	java.util.ResourceBundle bundle)</pre>
	<div class="block">Returns the instance of the <code>baseName</code> resource bundle
	for the given locale.

	<p> This method should be called from a derived class, with the proper
	casting:<blockquote>

	<pre>class MyResource extends ShadowResourceBundle {
	...

	/**
	* Retrieves the instance of {@link MyResource} appropriate
	* to the given locale.
	**/
	public static MyResource instance(Locale locale) {
	return (MyResource) instance(
	MyResource.class.getName(), locale,
	ResourceBundle.getBundle(MyResource.class.getName(), locale));
	}
	...
	}</pre></blockquote></div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>baseName</code> - Base name</dd>
	<dd><code>locale</code> - Locale</dd>
	<dd><code>bundle</code> - Resource bundle</dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>Resource bundle</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	</div>
	</main>
	<!-- ========= END OF CLASS DATA ========= -->
	<footer role="contentinfo">
	<nav role="navigation">
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a id="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/Resources.ShadowResourceBundle.html">Use</a></li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../index-all.html">Index</a></li>
	<li><a href="../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList" id="allclasses_navbar_bottom">
	<li><a href="../../../../allclasses.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_bottom");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li><a href="#nested.class.summary">Nested</a> \| </li>
	<li><a href="#field.summary">Field</a> \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li><a href="#field.detail">Field</a> \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<a id="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</nav>
	<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
	</footer>
	</body>
	</html>