Hugo Annotations

Annotation-triggered method call logging for your debug builds.

License	The Apache Software License, Version 2.0
GroupId	com.jakewharton.hugo
ArtifactId	hugo-annotations
Last Version	1.2.1
Release Date	Feb 18, 2015
Type	jar
Description	Hugo Annotations Annotation-triggered method call logging for your debug builds.
Project URL	https://github.com/JakeWharton/hugo/
Source Code Management	https://github.com/JakeWharton/hugo/

Download hugo-annotations

Filename	Size
hugo-annotations-1.2.1.pom
hugo-annotations-1.2.1.jar	833 bytes
hugo-annotations-1.2.1-sources.jar	755 bytes
hugo-annotations-1.2.1-javadoc.jar	30 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.jakewharton.hugo/hugo-annotations/ -->
<dependency>
    <groupId>com.jakewharton.hugo</groupId>
    <artifactId>hugo-annotations</artifactId>
    <version>1.2.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.jakewharton.hugo/hugo-annotations/
implementation 'com.jakewharton.hugo:hugo-annotations:1.2.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.jakewharton.hugo/hugo-annotations/
implementation ("com.jakewharton.hugo:hugo-annotations:1.2.1")

Apache Buildr

'com.jakewharton.hugo:hugo-annotations:jar:1.2.1'

Apache Ivy

<dependency org="com.jakewharton.hugo" name="hugo-annotations" rev="1.2.1">
  <artifact name="hugo-annotations" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.jakewharton.hugo', module='hugo-annotations', version='1.2.1')
)

Scala SBT

libraryDependencies += "com.jakewharton.hugo" % "hugo-annotations" % "1.2.1"

Leiningen

[com.jakewharton.hugo/hugo-annotations "1.2.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Hugo

Annotation-triggered method call logging for your debug builds.

As a programmer, you often add log statements to print method calls, their arguments, their return values, and the time it took to execute. This is not a question. Every one of you does this. Shouldn't it be easier?

Simply add @DebugLog to your methods and you will automatically get all of the things listed above logged for free.

@DebugLog
public String getName(String first, String last) {
  SystemClock.sleep(15); // Don't ever really do this!
  return first + " " + last;
}

V/Example: ⇢ getName(first="Jake", last="Wharton")
V/Example: ⇠ getName [16ms] = "Jake Wharton"

The logging will only happen in debug builds and the annotation itself is never present in the compiled class file for any build type. This means you can keep the annotation and check it into source control. It has zero effect on non-debug builds.

Add it to your project today!

buildscript {
  repositories {
    mavenCentral()
  }

  dependencies {
    classpath 'com.jakewharton.hugo:hugo-plugin:1.2.1'
  }
}

apply plugin: 'com.android.application'
apply plugin: 'com.jakewharton.hugo'

Disable logging temporarily by adding the following:

hugo {
  enabled false
}

If you want to toggle logging at runtime, use Hugo.setEnabled(true|false)

Local Development

Working on this project? Here's some helpful Gradle tasks:

• install - Install plugin, runtime, and annotations into local repo.
• cleanExample - Clean the example project build.
• assembleExample - Build the example project. Must run install first.
• installExample - Build and install the example project debug APK onto a device.

License

Copyright 2013 Jake Wharton

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Versions

Version
1.2.1 Feb 18, 2015
1.2.0 Feb 13, 2015
1.1.0 May 5, 2014
1.0.1 Dec 9, 2013
1.0.0 Dec 2, 2013