home | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Java example source code file (PrivateElements.java)

This example Java source code file (PrivateElements.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

element, injector, list, object, privateelements, set, util

The PrivateElements.java Java example source code

/**
 * Copyright (C) 2008 Google Inc.
 *
 * 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.inject.spi;

import com.google.inject.Injector;
import com.google.inject.Key;

import java.util.List;
import java.util.Set;

/**
 * A private collection of elements that are hidden from the enclosing injector or module by
 * default. See {@link com.google.inject.PrivateModule PrivateModule} for details.
 *
 * @author jessewilson@google.com (Jesse Wilson)
 * @since 2.0
 */
public interface PrivateElements extends Element {

  /**
   * Returns the configuration information in this private environment.
   */
  List<Element> getElements();

  /**
   * Returns the child injector that hosts these private elements, or null if the elements haven't
   * been used to create an injector.
   */
  Injector getInjector();

  /**
   * Returns the unique exposed keys for these private elements.
   */
  Set<Key getExposedKeys();

  /**
   * Returns an arbitrary object containing information about the "place" where this key was
   * exposed. Used by Guice in the production of descriptive error messages.
   *
   * <p>Tools might specially handle types they know about; {@code StackTraceElement} is a good
   * example. Tools should simply call {@code toString()} on the source object if the type is
   * unfamiliar.
   *
   * @param key one of the keys exposed by this module.
   */
  Object getExposedSource(Key<?> key);
}

Other Java examples (source code examples)

Here is a short list of links related to this Java PrivateElements.java source code file:



my book on functional programming

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.