From 2f58640bff16890539ddd71c847c732fcab24691 Mon Sep 17 00:00:00 2001 From: m_broelemann Date: Thu, 7 Jan 2021 18:11:10 +0100 Subject: [PATCH] =?UTF-8?q?code=20conventions=20und=20Kommentare=20hinzuge?= =?UTF-8?q?f=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../java/com/example/aped/MainActivity.java | 20 ++++++-- .../aped/communication/Communicator.java | 5 ++ .../aped/ui/all_IOs/AllIOsFragment.java | 5 +- .../ui/favorite_IOs/FavoriteIOsFragment.java | 4 +- .../ui/visualization/MainListViewAdapter.java | 26 ++++------ .../aped/ui/visualization/PinView.java | 18 ++----- .../com/example/aped/utils/TestFavorites.java | 48 ------------------- .../java/com/example/aped/utils/TestXML.java | 37 -------------- APED/app/src/main/res/values/drawables.xml | 24 +++++++--- APED/app/src/main/res/values/themes.xml | 12 +++-- 10 files changed, 65 insertions(+), 134 deletions(-) delete mode 100644 APED/app/src/main/java/com/example/aped/utils/TestFavorites.java delete mode 100644 APED/app/src/main/java/com/example/aped/utils/TestXML.java diff --git a/APED/app/src/main/java/com/example/aped/MainActivity.java b/APED/app/src/main/java/com/example/aped/MainActivity.java index fe19f15..773a33a 100644 --- a/APED/app/src/main/java/com/example/aped/MainActivity.java +++ b/APED/app/src/main/java/com/example/aped/MainActivity.java @@ -40,17 +40,25 @@ import static android.content.pm.PackageManager.PERMISSION_GRANTED; public class MainActivity extends AppCompatActivity { /** permission code for the storage permisson.*/ private static final int STORAGE_PERMISSION_CODE = 42; + /** What should be displayed in navigation.*/ private AppBarConfiguration mAppBarConfiguration; + /** To use xml instead of direct inclusion.*/ private IXML xml; + /** To use delivery instead of direct inclusion.*/ private Communicator delivery; + /** Handler for the custom user configurations. **/ private ConfigurationHandler configurationHandler; + /** To use favorite instead of direct inclusion.*/ private IFAVORITES favorite; + /** + * On create method of the main activity. + * Sets various displays and start settings. * @param savedInstanceState */ @Override @@ -66,14 +74,12 @@ public class MainActivity extends AppCompatActivity { setContentView(R.layout.activity_main); Toolbar toolbar = findViewById(R.id.toolbar); setSupportActionBar(toolbar); - DrawerLayout drawer = findViewById(R.id.drawer_layout); NavigationView navigationView = findViewById(R.id.nav_view); // Passing each menu ID as a set of Ids because each // menu should be considered as top level destinations. mAppBarConfiguration = new AppBarConfiguration.Builder( - R.id.nav_all_IOs, R.id.nav_your_IOs) - .setDrawerLayout(drawer) + R.id.nav_all_IOs, R.id.nav_your_IOs).setDrawerLayout(drawer) .build(); NavController navController = Navigation.findNavController(this, R.id.nav_host_fragment); @@ -285,6 +291,10 @@ public class MainActivity extends AppCompatActivity { } } + /** + * paul + * @param xmlFile + */ private void setDefaultXML(final File xmlFile) { try { InputStream inputStream = getAssets().open( @@ -301,6 +311,10 @@ public class MainActivity extends AppCompatActivity { } } + /** + * paul + * @param xmlFile + */ private void setDefaultConfig(final File xmlFile) { try { InputStream inputStream = getAssets().open( diff --git a/APED/app/src/main/java/com/example/aped/communication/Communicator.java b/APED/app/src/main/java/com/example/aped/communication/Communicator.java index 59634e2..208281c 100644 --- a/APED/app/src/main/java/com/example/aped/communication/Communicator.java +++ b/APED/app/src/main/java/com/example/aped/communication/Communicator.java @@ -162,6 +162,11 @@ public class Communicator { requestQueue.add(request); } + /** + * paul + * @param error + * @param method + */ private void handleError(final VolleyError error, final String method) { if (error instanceof ServerError) { Log.e("Communicator", "server error during " + method diff --git a/APED/app/src/main/java/com/example/aped/ui/all_IOs/AllIOsFragment.java b/APED/app/src/main/java/com/example/aped/ui/all_IOs/AllIOsFragment.java index 8621cfc..7fe3aaf 100644 --- a/APED/app/src/main/java/com/example/aped/ui/all_IOs/AllIOsFragment.java +++ b/APED/app/src/main/java/com/example/aped/ui/all_IOs/AllIOsFragment.java @@ -14,11 +14,8 @@ import com.example.aped.ui.visualization.MainListViewAdapter; public class AllIOsFragment extends Fragment { - /** - * Include the MainActivity. - */ + /** Include the MainActivity.*/ private MainActivity mainActivity; - /** * Compiling the data and calling up the AllIOs view. * @param inflater diff --git a/APED/app/src/main/java/com/example/aped/ui/favorite_IOs/FavoriteIOsFragment.java b/APED/app/src/main/java/com/example/aped/ui/favorite_IOs/FavoriteIOsFragment.java index 13d31f4..be89efa 100644 --- a/APED/app/src/main/java/com/example/aped/ui/favorite_IOs/FavoriteIOsFragment.java +++ b/APED/app/src/main/java/com/example/aped/ui/favorite_IOs/FavoriteIOsFragment.java @@ -14,9 +14,7 @@ import com.example.aped.R; import com.example.aped.ui.visualization.MainListViewAdapter; public class FavoriteIOsFragment extends Fragment { - /** - * Include the MainActivity. - */ + /** Include the MainActivity.*/ private MainActivity mainActivity; /** *Compiling the data and calling up the FavoriteIOs view. diff --git a/APED/app/src/main/java/com/example/aped/ui/visualization/MainListViewAdapter.java b/APED/app/src/main/java/com/example/aped/ui/visualization/MainListViewAdapter.java index cd65726..4fac387 100644 --- a/APED/app/src/main/java/com/example/aped/ui/visualization/MainListViewAdapter.java +++ b/APED/app/src/main/java/com/example/aped/ui/visualization/MainListViewAdapter.java @@ -14,28 +14,17 @@ import java.util.List; public class MainListViewAdapter extends BaseAdapter { - /** - * Einbinden der MainActivity. - */ + /** Include the MainActivity.*/ private MainActivity mainActivity; - /** - * Which view was selected, 0 for all IOs, 1 for favorite IOs. - */ + /** Which view was selected, 0 for all IOs, 1 for favorite IOs.*/ private int favoriteMode; - /** - * Name of the device for the current run. - */ + /** Name of the device for the current run.*/ private String deviceName; - /** - * Image for favorite or not. - */ + /** Image for favorite or not.*/ private int favoriteImage; - /** - * List of favorites existing when opening the favorites view. - */ + /** List of favorites existing when opening the favorites view.*/ private List favoritenList; - /** * Transfer of data to MainListViewAdapter. * @param pMainActivity @@ -65,6 +54,9 @@ public class MainListViewAdapter extends BaseAdapter { } /** + * This function is used to retrieve the data item associated. + * With the specified position in the data set to get the corresponding + * data of the specified location in the data collection. * @param position * @return */ @@ -75,6 +67,8 @@ public class MainListViewAdapter extends BaseAdapter { } /** + * As for the getItemId it returns the corresponding item element ID. + * The function returns a long item position value to the adapter. * @param position * @return */ diff --git a/APED/app/src/main/java/com/example/aped/ui/visualization/PinView.java b/APED/app/src/main/java/com/example/aped/ui/visualization/PinView.java index b6d20a9..a86e9d5 100644 --- a/APED/app/src/main/java/com/example/aped/ui/visualization/PinView.java +++ b/APED/app/src/main/java/com/example/aped/ui/visualization/PinView.java @@ -16,21 +16,13 @@ import java.util.ArrayList; import java.util.List; public class PinView { - /** - * Include the MainActivity. - */ + /** Include the MainActivity.*/ private MainActivity mainActivity; - /** - * Image for state. - */ + /** Image for state.*/ private int image; - /** - * Values of the pins. - */ + /** Values of the pins.*/ private List pinValues = new ArrayList<>(); - /** - * Device name. - */ + /** Device name.*/ private String deviceName; /** @@ -44,7 +36,7 @@ public class PinView { } /** - * Processing of the data in nzeigetezte of the pins frequencies and + * Processing of the data in displayed texts of the pins frequencies and * dutycycle as well as the status lamps. * @param i * @return view diff --git a/APED/app/src/main/java/com/example/aped/utils/TestFavorites.java b/APED/app/src/main/java/com/example/aped/utils/TestFavorites.java deleted file mode 100644 index ba2c5b7..0000000 --- a/APED/app/src/main/java/com/example/aped/utils/TestFavorites.java +++ /dev/null @@ -1,48 +0,0 @@ -package com.example.aped.utils; - -import java.util.ArrayList; -import java.util.List; - -/** - * implementation for the favorites interface - * does not use persistent storage! - */ -public class TestFavorites implements IFAVORITES { - - /** - * Liste der favoriten. - */ - private List favorites = new ArrayList<>(); - - /** - * @return - */ - @Override - public List getFavorites() { - return favorites; - } - - /** - * @param deviceName the name of the device to be added - * @return - */ - @Override - public String addFavorite(final String deviceName) { - if (!favorites.contains(deviceName)) { - favorites.add(deviceName); - } - return deviceName; - } - - /** - * @param deviceName the name of the device to be removed - * @return - */ - @Override - public String removeFavorite(final String deviceName) { - if (favorites.contains(deviceName)) { - favorites.remove(deviceName); - } - return deviceName; - } -} diff --git a/APED/app/src/main/java/com/example/aped/utils/TestXML.java b/APED/app/src/main/java/com/example/aped/utils/TestXML.java deleted file mode 100644 index 1207ba1..0000000 --- a/APED/app/src/main/java/com/example/aped/utils/TestXML.java +++ /dev/null @@ -1,37 +0,0 @@ -package com.example.aped.utils; - - -import java.util.ArrayList; -import java.util.Dictionary; -import java.util.Hashtable; -import java.util.List; - -public class TestXML implements IXML { - - /** - * @return - */ - @Override - public List getDeviceNames() { - List returnList = new ArrayList<>(); - returnList.add("stoff"); - returnList.add("schnaps"); - returnList.add("whatever"); - return returnList; - } - - /** - * @param deviceName the name of the relevant device - * @return - */ - @Override - public Dictionary getPort(final String deviceName) { - Dictionary returnDict = new Hashtable<>(); - returnDict.put("protocol", "DI"); - Dictionary pins = new Hashtable<>(); - pins.put("GPIO2", true); - pins.put("GPIO3", false); - returnDict.put("pins", pins); - return returnDict; - } -} diff --git a/APED/app/src/main/res/values/drawables.xml b/APED/app/src/main/res/values/drawables.xml index c4e4cea..c09c375 100644 --- a/APED/app/src/main/res/values/drawables.xml +++ b/APED/app/src/main/res/values/drawables.xml @@ -1,8 +1,20 @@ - @android:drawable/ic_menu_camera - @android:drawable/ic_menu_gallery - @android:drawable/ic_menu_slideshow - @android:drawable/ic_menu_manage - @android:drawable/ic_menu_share - @android:drawable/ic_menu_send + + @android:drawable/ic_menu_camera + + + @android:drawable/ic_menu_gallery + + + @android:drawable/ic_menu_slideshow + + + @android:drawable/ic_menu_manage + + + @android:drawable/ic_menu_share + + + @android:drawable/ic_menu_send + \ No newline at end of file diff --git a/APED/app/src/main/res/values/themes.xml b/APED/app/src/main/res/values/themes.xml index cf6ff74..a1f07ec 100644 --- a/APED/app/src/main/res/values/themes.xml +++ b/APED/app/src/main/res/values/themes.xml @@ -1,6 +1,7 @@ - @@ -19,7 +21,9 @@ true -