Skip to content

Latest commit

 

History

History
80 lines (66 loc) · 2.79 KB

README.md

File metadata and controls

80 lines (66 loc) · 2.79 KB

Android Arsenal API Join the chat at https://gitter.im/orhanobut/hawk Build Status

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

Download

compile "com.orhanobut:hawk:2.0.1"

Initialize

Hawk.init(context).build();

Usage

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

Hawk.put(key, T);

Get the original value with the original type

T value = Hawk.get(key);

Delete any entry

Hawk.delete(key);

Check if any key exists

Hawk.contains(key);

Check total entry count

Hawk.count();

Get crazy and delete everything

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