Home | History | Annotate | Download | only in phonenumbers
      1 /*
      2  * Copyright (C) 2014 The Libphonenumber Authors
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  * http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package com.android.i18n.phonenumbers;
     18 
     19 import java.io.InputStream;
     20 
     21 /**
     22  * Interface for caller to specify a customized phone metadata loader.
     23  */
     24 public interface MetadataLoader {
     25   /**
     26    * Returns an input stream corresponding to the metadata to load.
     27    *
     28    * @param metadataFileName File name (including path) of metadata to load. File path is an
     29    *     absolute class path like /com/android/i18n/phonenumbers/data/PhoneNumberMetadataProto.
     30    * @return The input stream for the metadata file. The library will close this stream
     31    *     after it is done. Return null in case the metadata file could not be found.
     32    */
     33   public InputStream loadMetadata(String metadataFileName);
     34 }
     35