org.apache.solr.common.ResourceLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of solr-common Show documentation

Apache Solr Common

The newest version!

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.solr.common;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**
 * @since solr 1.3
 */ 
public interface ResourceLoader
{
  public InputStream openResource(String resource) throws IOException;
  
  /**
   * Accesses a resource by name and returns the (non comment) lines
   * containing data.
   *
   * 
   * A comment line is any line that starts with the character "#"
   * 
   *
   * @param resource
   * @return a list of non-blank non-comment lines with whitespace trimmed
   * from front and back.
   * @throws IOException
   */
  public List getLines(String resource) throws IOException;
  
  public Object newInstance(String cname, String ... subpackages);
}