Skip to content

Commit

Permalink
Add @SInCE tag to all classes
Browse files Browse the repository at this point in the history
  • Loading branch information
hjorthjort committed Oct 2, 2015
1 parent 5118d49 commit 5f45c4e
Show file tree
Hide file tree
Showing 28 changed files with 35 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
/**
* @author hjorthjort
* Created 29/09/15
* @since 0.1
*/
public class WifiHelperTest extends AndroidTestCase {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

import android.test.AndroidTestCase;

import com.alive_n_clickin.commutity.infrastructure.api.JsonJavaConverter;
import com.google.gson.internal.LinkedTreeMap;

/**
* @author hjorthjort
* Created 22/09/15
* @since 0.1
*/
public class JsonJavaConverterTest extends AndroidTestCase {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

/**
*
* @since 0.1
*/
public class GpsState implements LocationListener{
private static GpsState instance;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* Created 24/09/15
*
* Class for finding nearby vehicles based on wifi position.
* @since 0.1
*/
public class NearbyVehiclesScanner {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
/**
* @author hjorthjort
* Created 26/09/15
* @since 0.1
*/
public class WifiBroadcastReceiver extends BroadcastReceiver {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* Created 24/09/15
*
* Singleton tool for getting wifi information
* @since 0.1
*/
public class WifiHelper {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* The current adapters are:
* {@link IVasttrafikAdapter}
* {@link IElectricityAdapter}
* @since 0.1
*/
public class ApiAdapterFactory {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
*
* For connecting to different API:s. Allows abstraction by letting us send only the query parameters to the api we want, not bothering about authentication and the likes.
* ApiConnection is package private: no need for layers higher up to use it directly!
* @since 0.1
*/
class ApiConnection {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package com.alive_n_clickin.commutity.infrastructure.api;


/**
*
* @since 0.1
*/
class ElectricityAdapter implements IElectricityAdapter {

}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

/**
* This interface represent the possible request to the Electricity API combined with their responses.
* @since 0.1
*/
public interface IElectricityAdapter {
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

/**
* This interface represent the possible request to the Vasttrafik API combined with their responses.
* @since 0.1
*/
public interface IVasttrafikAdapter {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* Methods for parsing JSON in to Java Objects of a given class, and vice versa
*
* Package private, this class handles low level functionality, and should not be visible to other packages.
* @since 0.1
*/
class JsonJavaConverter<T> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

/**
* This class models the response from the Vasttrafik API and is used within {@link JsonJavaConverter} to convert into a java object.
* @since 0.1
*/
public class LocationList {
private String noNamespaceSchemaLocation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* so it can be sent in intents, bundles, etc.
*
* The class is used within {@link JsonJavaConverter} to convert the json into a java object.
* @since 0.1
*/
@ToString public class Stop implements Serializable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* Use the ApiAdapterFactory to gain access to this class. {@link ApiAdapterFactory}
*
* This class is used to create a suitable request string, which is then passed along to {@link VasttrafikApiConnection}
* @since 0.1
*/
class VasttrafikAdapter implements IVasttrafikAdapter {
private final VasttrafikApiConnection vasttrafikApiConnection = new VasttrafikApiConnection();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* This class creates a valid http connection for the Vasttrafik API, which is then passed along to {@link ApiConnection}.
*
* The class is not meant to be instantiated directly. It's only used within {@link VasttrafikAdapter} to remove coupling.
* @since 0.1
*/
class VasttrafikApiConnection {
private static final String BASE_URL_VASTTRAFIK =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* A class containing data for a flag button. The button consists visually of an image and a
* description, and these are stored as a resource ID and a string. The type of flag is also
* stored here.
* @since 0.1
*/
public class FlagButton{
private int imageID;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* The main activity for the flag setting tool. The activity doesn't have any visual elements itself,
* besides a frame which contains different fragments. The activity extends FragmentActivity to ensure
* that switching fragments is pain free.
* @since 0.1
*/
public class FlagVehicle extends FragmentActivity {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
* A class for showing the detailed view when flagging a vehicle. The view contains a flag, its name,
* a comment field and a button for sending the flag. This fragment class handles then visual elements
* of this.
* @since 0.1
*/

public class FlagVehicleDetailFragment extends Fragment {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
/**
* The view with several different flags available for the user to flag vehicles. Launches a detailed
* view when the user clicks on a flag
* @since 0.1
*/
public class FlagVehicleFragment extends Fragment implements WifiChangeListener {
final static String ARG_POSITION = "position";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

/**
* An adapter for transforming flag data into a grid view
* @since 0.1
*/
public class FlagViewAdapter extends BaseAdapter {
private Context currentContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/**
* @author hjorthjort
* Created 26/09/15
* @since 0.1
*/
public interface WifiChangeListener {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,18 @@
import android.support.v4.app.FragmentTransaction;
import android.view.View;

import lombok.Setter;
import lombok.Getter;

import com.alive_n_clickin.commutity.R;
import com.alive_n_clickin.commutity.infrastructure.api.Stop;
import com.alive_n_clickin.commutity.presentation.flagreport.FlagVehicle;
import com.alive_n_clickin.commutity.presentation.search.SearchFragment;

import lombok.Getter;
import lombok.Setter;

/**
* This class handles the first view presented to the user. It has a content frame to hold different
* fragments.
* @since 0.1
*/
public class MainActivity extends FragmentActivity {
@Getter @Setter private Stop currentStop;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
/**
* This class handles the first view presented to the user. It holds the stop the user has selected,
* as well as handling the switching to the search fragment when the user presses the stop text view.
* @since 0.1
*/

public class MainFragment extends Fragment {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
/**
* A fragment for the search function. Contains a edit text field for inputting a search term
* and a list containing the results
* @since 0.1
*/
public class SearchFragment extends Fragment {
SearchView search;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

/**
* Converts the stop to a string to display in a view, i.e. the search result list
* @since 0.1
*/
public class SearchResultAdapter extends ArrayAdapter<Stop> {
public SearchResultAdapter(Context context, List<Stop> result) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

/**
* The different flag types available
* @since 0.1
*/
public enum FlagType {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
/**
* @author hjorthjort
* Created 22/09/15
*
* @since 0.1
*/
public class LogUtils {
public static String getLogTag(Object caller) {
Expand Down

0 comments on commit 5f45c4e

Please sign in to comment.