https://github.com/square/auto-value-redacted

An extension for Google's AutoValue that omits redacted fields from toString().
https://github.com/square/auto-value-redacted

Last synced: about 1 month ago
JSON representation

An extension for Google's AutoValue that omits redacted fields from toString().

• Host: GitHub
• URL: https://github.com/square/auto-value-redacted
• Owner: square
• License: apache-2.0
• Created: 2015-08-14T04:48:05.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-03-19T08:30:39.000Z (over 1 year ago)
• Last Synced: 2024-04-13T17:52:13.143Z (5 months ago)
• Language: Java
• Homepage:
• Size: 143 KB
• Stars: 211
• Watchers: 25
• Forks: 15
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# AutoValue: Redacted Extension

An extension for Google's [AutoValue](https://github.com/google/auto/tree/master/value) 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.

```java

@Retention(SOURCE)

@Target({METHOD, PARAMETER, FIELD})

public @interface Redacted {

}

```

```java

@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:

```groovy

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

```

or Maven:

```xml

  com.squareup.auto.value

  auto-value-redacted

  1.1.1

  provided

```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].

## 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.

```

 [snap]: https://oss.sonatype.org/content/repositories/snapshots/

 [apt]: https://bitbucket.org/hvisser/android-apt