1 /*
2  * Copyright (C) 2018 The Android Open Source Project
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.server.wifi;
18 
19 import android.net.wifi.WifiConfiguration;
20 
21 import org.xmlpull.v1.XmlPullParser;
22 import org.xmlpull.v1.XmlPullParserException;
23 
24 import java.io.IOException;
25 import java.util.List;
26 
27 /**
28  * Interface describing parser of WiFi backup data for each major version.
29  * Note that implementations of this interface should be returned
30  * from {@link WifiBackupRestore#getWifiBackupDataParser()} method based on major version they
31  * belong to.
32  */
33 interface WifiBackupDataParser {
34 
35     /**
36      * Parses the list of configurations from the provided XML stream.
37      *
38      * @param in            XmlPullParser instance pointing to the XML stream.
39      * @param outerTagDepth depth of the outer tag in the XML document.
40      * @param minorVersion  minor version number parsed from incoming data.
41      * @return List<WifiConfiguration> object if parsing is successful, null otherwise.
42      */
parseNetworkConfigurationsFromXml(XmlPullParser in, int outerTagDepth, int minorVersion)43     List<WifiConfiguration> parseNetworkConfigurationsFromXml(XmlPullParser in, int outerTagDepth,
44             int minorVersion) throws XmlPullParserException, IOException;
45 }
46