Licenser

Additional

Language
Java
Version
1.0.2 (Apr 14, 2018)
Created
Feb 11, 2018
Updated
Apr 14, 2018
Owner
Marcos Calvo García (marcoscgdev)
Contributors
Marcos Calvo García (marcoscgdev)
Aubtin
2
Activity
Badge
Generate
Download
Source code

Show card

Licenser

An android library to display the licenses of your application libraries in a easy way.

Click here for the Kotlin version of this readme.


Releases:

Current release: 1.0.2.

You can see all the library releases here.


Demo:

You can download the sample apk here.


Usage:

Step: 1 - adding the library via Gradle

First of all add this to your root build.gradle file:

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

Now add the dependency to your app build.gradle file:

compile 'com.github.marcoscgdev:Licenser:1.0.2'

Step: 2 - creating a dialog

You have to use an AppCompatActivity

new LicenserDialog(this)
        .setTitle("Licenses")
        .setCustomNoticeTitle("Notices for files:")
        .setLibrary(new Library("Android Support Libraries",
                "https://developer.android.com/topic/libraries/support-library/index.html",
                License.APACHE))
        .setLibrary(new Library("Example Library",
                "https://github.com/marcoscgdev",
                License.APACHE))
        .setLibrary(new Library("Licenser",
                "https://github.com/marcoscgdev/Licenser",
                License.MIT))
        .setPositiveButton(android.R.string.ok, new DialogInterface.OnClickListener() {
            @Override
            public void onClick(DialogInterface dialogInterface, int i) {
                // TODO: 11/02/2018
            }
        })
        .show();

Library structure:

Library lib1 = new Library(String title, String url, int licenseType);

LICENSE TYPES (At this moment):

 - License.APACHE
 - License.MIT
 - License.GNU
Library lib1 = new Library("Library name", "https://github.com/marcoscgdev", License.APACHE);

If you don't want a dialog, you can use the Licenser class:

Licenser licenser = new Licenser()
        .setCustomNoticeTitle("Notices for files:")
        .setLibrary(new Library("Android Support Libraries",
                "https://developer.android.com/topic/libraries/support-library/index.html",
                License.APACHE))
        .setLibrary(new Library("Example Library",
                "https://github.com/marcoscgdev",
                License.APACHE))
        .setLibrary(new Library("Licenser",
                "https://github.com/marcoscgdev/Licenser",
                License.MIT));

And show it in a webview:

WebView webView = (WebView) findViewById(R.id.webView);
webView.loadData(licenser.getHTMLContent(), "text/html; charset=UTF-8", null);

Extra functions

You can access this functions with both classes

String licenses = licenser.getHTMLContent(); // HTML content
List<Library> apacheLibraries = licenser.getApacheLibraries();
List<Library> mitLibraries = licenser.getMitLibraries();
List<Library> gnuLibraries = licenser.getGnuLibraries();

See the sample project to clarify any queries you may have.


License

The MIT License (MIT)

Copyright (c) 2018 Marcos Calvo García

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.