https://github.com/orhanobut/hawk

✔️ Secure, simple key-value storage for Android
https://github.com/orhanobut/hawk

android encryption hawk key-value-store preferences security sharedpreferences storage

Last synced: about 1 month ago
JSON representation

✔️ Secure, simple key-value storage for Android

• Host: GitHub
• URL: https://github.com/orhanobut/hawk
• Owner: orhanobut
• License: apache-2.0
• Created: 2015-02-19T22:25:23.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-07-10T10:09:05.000Z (about 2 years ago)
• Last Synced: 2024-07-11T14:59:44.273Z (about 2 months ago)
• Topics: android, encryption, hawk, key-value-store, preferences, security, sharedpreferences, storage
• Language: Java
• Homepage:
• Size: 944 KB
• Stars: 3,978
• Watchers: 99
• Forks: 387
• Open Issues: 49
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Hawk-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/1568)      [![API](https://img.shields.io/badge/API-10%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=10)   [![Join the chat at https://gitter.im/orhanobut/hawk](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/orhanobut/hawk?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)  [![](https://img.shields.io/badge/AndroidWeekly-%23141-blue.svg)](http://androidweekly.net/issues/issue-141)  [![Build Status](https://travis-ci.org/orhanobut/hawk.svg?branch=master)](https://travis-ci.org/orhanobut/hawk)



### Hawk 2.0

Secure, simple key-value storage for android

#### Important Note

This version has no backward compatibility with Hawk 1+ versions. If you still want to use old versions, [check here](https://github.com/orhanobut/hawk/tree/hawk1)

### Download

```groovy

compile "com.orhanobut:hawk:2.0.1"

```

### Initialize

```java

Hawk.init(context).build();

```

### Usage

Save any type (Any object, primitives, lists, sets, maps ...)

```java

Hawk.put(key, T);

```

Get the original value with the original type

```java

T value = Hawk.get(key);

```

Delete any entry

```java

Hawk.delete(key);

```

Check if any key exists

```java

Hawk.contains(key);

```

Check total entry count

```java

Hawk.count();

```

Get crazy and delete everything

```java

Hawk.deleteAll();

```

### How does Hawk work?



### More options

- Everything is pluggable, therefore you can change any layer with your custom implementation.

- NoEncryption implementation is provided out of box If you want to disable crypto.

```java

Hawk.init(context)

  .setEncryption(new NoEncryption())

  .setLogInterceptor(new MyLogInterceptor())

  .setConverter(new MyConverter())

  .setParser(new MyParser())

  .setStorage(new MyStorage())

  .build();

```

### License


Copyright 2016 Orhan Obut


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.