Grundaufbau der App
[DHBWCampusApp.git] / app / src / main / java / de / dhbwloe / campusapp / nfcreader / cardreader / ICardReader.java
1 /*
2  * ICardReader.java
3  *
4  * Copyright (C) 2014 Jakob Wenzel
5  *
6  * Authors:
7  * Jakob Wenzel <jakobwenzel92@gmail.com>
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  */
22
23 package de.dhbwloe.campusapp.nfcreader.cardreader;
24
25 import com.codebutler.farebot.card.desfire.DesfireException;
26 import com.codebutler.farebot.card.desfire.DesfireProtocol;
27
28 public interface ICardReader {
29         /**
30          * Try to read data from a card.
31          *
32          * An implementer should only throw exceptions on communication errors, but not because the card
33          * does not contain the required data. In that case, null should be returned.
34          *
35          * @param card The card to read
36          * @return Card's data, null if unsupported.
37          * @throws DesfireException Communication error
38          */
39         public NfcCardData readCard(DesfireProtocol card) throws DesfireException;
40 }