Trail


Source link: https://github.com/mauriciotogneri/trail

Trail

Trail is a simple logging system for Java and Android. Create logs using the same API and the library will detect automatically in which platform the code is running.

Features

  • Easy and direct
  • Same API for Java/Android logging
  • 5 log levels:
    • VERBOSE
    • DEBUG
    • INFO
    • WARNING
    • ERROR
  • 5 different ways to create logs for each level
  • Register/unregister listeners for log events

Log parameters

  • Tag: The tag of the log. It can be any object from which the method toString() will be called. If missing, a default tag with the name of the class where the log is created will be used.

  • Message: The message of the log. It can be any object from which the method toString() will be called.

  • Exception: The exception of the log (if any).

Examples

 // providing only a message  Trail.verbose("Applicatio started!");
 // providing a tag and a message  Trail.info("LOGIN", "Successful");
 try  {

// do something  
}
  catch (Exception e)  {

// providing only an exception

Trail.debug(e);
  
}
 try  {

// do something  
}
  catch (NetworkException e)  {

// providing a tag and an exception

Trail.warning("NETWORK_PROBLEM", e);
  
}
 try  {

// do something  
}
  catch (SQLException e)  {

// providing a tag, a message and an exception

Trail.error("DATABASE_PROBLEM", "Invalid query format", e);
  
}

Utils

The library provides a method to retrieve the current location of the executing code:

 Trail.getCodeLocation()

This method returns an instance of the class CodeLocation that contains the name of the thread, the name of the class, the name of the method, the line number and the stack trace of the line of code being executed at that moment. This can be used to add more information to a log.

For example:

 Trail.verbose("LOCATION", "I am at " + Trail.getCodeLocation());

Could generate the following output:

 LOCATION: I am at [main]Sample.run:78 

Listeners

The library allows to register/unregister listeners to be informed when a log is created:

 public class SampleListener implements Listener  {

public void run()

{

 // register the object to receive log events

 Trail.register(this);

  // the object will be informed about the following log

 Trail.verbose("Message 1");

  // unregister the object to stop receiving log events

 Trail.unregister(this);

  // the object will NOT be informed about the following log

 Trail.info("Tag", "Message 2");

}

 @Override

public void onLog(TrailLog log)

{

 // TODO: process log information (write in a file/database, send by network, etc.)

}
  
}

Global settings

Enable/disable log printing (enabled by default):

 // disables the log printing  Trail.enableLogPrinting(false);

Enable/disable listeners notification (enabled by default):

 // disables the listener notification  Trail.enableListenerNotification(false);

Download

Latest JAR:

Maven (from JCenter):

<dependency>
  <groupId>com.mauriciotogneri</groupId>
  <artifactId>trail</artifactId>
  <version>1.0.0</version> </dependency>

Adding JCenter to pom.xml:

<repositories>
  <repository>

<id>central</id>

<name>bintray</name>

<url>http://jcenter.bintray.com</url>
  </repository> </repositories> 

Gradle (from JCenter):

compile 'com.mauriciotogneri:trail:1.0.0'

Adding JCenter to build.gradle:

repositories {

  maven {

url  "http://jcenter.bintray.com"

}
 
}

Compatibility

Trail works with any version of Java and Android.

License

The MIT License (MIT)  Copyright (c) 2015 Mauricio Togneri  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 

Resources

A pretty Music Player demo created by Anish Chandran and coded by André Mion

VirtualApp is an open platform for Android that allows you to create a Virtual Space, you can install and run apk inside. Beyond that, VirtualApp is also a Plugin Framework.

Cosmos Browser allows the user to connect to the internet through the use of SMS. No data or WiFi required.

Android Markdown editor.

This project allows to dump files from oat dex tool.

A reactive (Rx) implementation of the AudioRecord API for recording raw (pcm) audio-data. Also includes helper methods for the creation of Wave audio files.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes