Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 1.73 KB

README.md

File metadata and controls

76 lines (53 loc) · 1.73 KB
Raw

AutoValue: Redacted Extension

An extension for Google's AutoValue that omits @Redacted field values from toString().

Usage

Include the extension in your project, define a @Redacted annotation, and apply it to any fields that you wish to redact.

@Retention(SOURCE)
@Target({METHOD, PARAMETER, FIELD})
public @interface Redacted {
}
@AutoValue
public abstract class User {
  public abstract String name();
  @Redacted public abstract String phoneNumber();
}

When you call toString() any @Redacted properties are hidden:

User{name=Bob, phoneNumber=██}

Download

Add a Gradle dependency:

annotationProcessor 'com.squareup.auto.value:auto-value-redacted:1.0.1'

or Maven:

<dependency>
  <groupId>com.squareup.auto.value</groupId>
  <artifactId>auto-value-redacted</artifactId>
  <version>1.0.1</version>
  <scope>provided</scope>
</dependency>

Snapshots of the development version are available in Sonatype's snapshots repository.

License

Copyright 2015 Square, Inc.

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.