├── .idea ├── .name ├── copyright │ └── profiles_settings.xml ├── encodings.xml ├── modules.xml ├── runConfigurations.xml ├── gradle.xml ├── compiler.xml └── misc.xml ├── app ├── .gitignore ├── src │ ├── main │ │ ├── res │ │ │ ├── values │ │ │ │ ├── strings.xml │ │ │ │ ├── colors.xml │ │ │ │ ├── dimens.xml │ │ │ │ └── styles.xml │ │ │ ├── mipmap-hdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── mipmap-mdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── mipmap-xhdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── mipmap-xxhdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── mipmap-xxxhdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── values-w820dp │ │ │ │ └── dimens.xml │ │ │ └── layout │ │ │ │ └── activity_main.xml │ │ ├── AndroidManifest.xml │ │ └── java │ │ │ └── news │ │ │ └── androidtv │ │ │ └── samples │ │ │ └── filepicker │ │ │ └── MainActivity.java │ ├── test │ │ └── java │ │ │ └── news │ │ │ └── androidtv │ │ │ └── filepicker │ │ │ └── ExampleUnitTest.java │ └── androidTest │ │ └── java │ │ └── news │ │ └── androidtv │ │ └── filepicker │ │ └── ExampleInstrumentedTest.java ├── proguard-rules.pro └── build.gradle ├── library ├── .gitignore ├── src │ ├── main │ │ ├── res │ │ │ ├── values │ │ │ │ └── strings.xml │ │ │ └── drawable │ │ │ │ └── ic_folder_white_24dp.xml │ │ ├── AndroidManifest.xml │ │ └── java │ │ │ └── news │ │ │ └── androidtv │ │ │ └── filepicker │ │ │ ├── filters │ │ │ ├── EmptyFilter.java │ │ │ ├── DirectoryFilter.java │ │ │ ├── FilterInterface.java │ │ │ └── FileExtensionFilter.java │ │ │ ├── model │ │ │ └── AbstractFile.java │ │ │ └── FilePickerFragment.java │ ├── test │ │ └── java │ │ │ └── news │ │ │ └── androidtv │ │ │ └── filepicker │ │ │ └── ExampleUnitTest.java │ └── androidTest │ │ └── java │ │ └── news │ │ └── androidtv │ │ └── filepicker │ │ └── ExampleInstrumentedTest.java ├── proguard-rules.pro └── build.gradle ├── settings.gradle ├── device-2016-09-22-000325.png ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .gitignore ├── gradle.properties ├── gradlew.bat ├── gradlew └── LICENSE /.idea/.name: -------------------------------------------------------------------------------- 1 | FilePicker -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /library/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':app', ':library' 2 | -------------------------------------------------------------------------------- /device-2016-09-22-000325.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ITVlab/TvFilePicker/HEAD/device-2016-09-22-000325.png -------------------------------------------------------------------------------- /.idea/copyright/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | FilePicker 3 | 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ITVlab/TvFilePicker/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /library/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Library 3 | 4 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ITVlab/TvFilePicker/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ITVlab/TvFilePicker/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ITVlab/TvFilePicker/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ITVlab/TvFilePicker/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ITVlab/TvFilePicker/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/workspace.xml 5 | /.idea/libraries 6 | .DS_Store 7 | /build 8 | /captures 9 | .externalNativeBuild 10 | -------------------------------------------------------------------------------- /.idea/encodings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #3F51B5 4 | #303F9F 5 | #FF4081 6 | 7 | -------------------------------------------------------------------------------- /app/src/main/res/values/dimens.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16dp 4 | 16dp 5 | 6 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Mon Dec 28 10:00:20 PST 2015 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.14.1-all.zip 7 | -------------------------------------------------------------------------------- /library/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 3 | 4 | 6 | 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /app/src/main/res/values-w820dp/dimens.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 64dp 6 | 7 | -------------------------------------------------------------------------------- /app/src/main/res/values/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /library/src/main/res/drawable/ic_folder_white_24dp.xml: -------------------------------------------------------------------------------- 1 | 6 | 9 | 10 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /app/src/test/java/news/androidtv/filepicker/ExampleUnitTest.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker; 2 | 3 | import org.junit.Test; 4 | 5 | import static org.junit.Assert.*; 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * @see Testing documentation 11 | */ 12 | public class ExampleUnitTest { 13 | @Test 14 | public void addition_isCorrect() throws Exception { 15 | assertEquals(4, 2 + 2); 16 | } 17 | } -------------------------------------------------------------------------------- /library/src/test/java/news/androidtv/filepicker/ExampleUnitTest.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker; 2 | 3 | import org.junit.Test; 4 | 5 | import static org.junit.Assert.*; 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * @see Testing documentation 11 | */ 12 | public class ExampleUnitTest { 13 | @Test 14 | public void addition_isCorrect() throws Exception { 15 | assertEquals(4, 2 + 2); 16 | } 17 | } -------------------------------------------------------------------------------- /library/src/main/java/news/androidtv/filepicker/filters/EmptyFilter.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker.filters; 2 | 3 | import news.androidtv.filepicker.model.AbstractFile; 4 | 5 | /** 6 | * A generic implementation of a {@link FilterInterface} that returns true in all instances. 7 | */ 8 | public class EmptyFilter implements FilterInterface { 9 | @Override 10 | public boolean matches(AbstractFile file) { 11 | return true; 12 | } 13 | 14 | @Override 15 | public String getDescription() { 16 | return "Select a file"; 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /library/src/main/java/news/androidtv/filepicker/filters/DirectoryFilter.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker.filters; 2 | 3 | import news.androidtv.filepicker.model.AbstractFile; 4 | 5 | /** 6 | * A type of {@link FilterInterface} that only matches with directories. 7 | */ 8 | public class DirectoryFilter implements FilterInterface { 9 | @Override 10 | public boolean matches(AbstractFile file) { 11 | return file.isDirectory(); 12 | } 13 | 14 | @Override 15 | public String getDescription() { 16 | return "Select a directory"; 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /.idea/runConfigurations.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 12 | -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 12 | 13 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # By default, the flags in this file are appended to flags specified 3 | # in C:\Users\Nick\AppData\Local\Android\sdk/tools/proguard/proguard-android.txt 4 | # You can edit the include path and order by changing the proguardFiles 5 | # directive in build.gradle. 6 | # 7 | # For more details, see 8 | # http://developer.android.com/guide/developing/tools/proguard.html 9 | 10 | # Add any project specific keep options here: 11 | 12 | # If your project uses WebView with JS, uncomment the following 13 | # and specify the fully qualified class name to the JavaScript interface 14 | # class: 15 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 16 | # public *; 17 | #} 18 | -------------------------------------------------------------------------------- /library/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # By default, the flags in this file are appended to flags specified 3 | # in C:\Users\Nick\AppData\Local\Android\sdk/tools/proguard/proguard-android.txt 4 | # You can edit the include path and order by changing the proguardFiles 5 | # directive in build.gradle. 6 | # 7 | # For more details, see 8 | # http://developer.android.com/guide/developing/tools/proguard.html 9 | 10 | # Add any project specific keep options here: 11 | 12 | # If your project uses WebView with JS, uncomment the following 13 | # and specify the fully qualified class name to the JavaScript interface 14 | # class: 15 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 16 | # public *; 17 | #} 18 | -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | 3 | # IDE (e.g. Android Studio) users: 4 | # Gradle settings configured through the IDE *will override* 5 | # any settings specified in this file. 6 | 7 | # For more details on how to configure your build environment visit 8 | # http://www.gradle.org/docs/current/userguide/build_environment.html 9 | 10 | # Specifies the JVM arguments used for the daemon process. 11 | # The setting is particularly useful for tweaking memory settings. 12 | org.gradle.jvmargs=-Xmx1536m 13 | 14 | # When configured, Gradle will run in incubating parallel mode. 15 | # This option should only be used with decoupled projects. More details, visit 16 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 17 | # org.gradle.parallel=true 18 | -------------------------------------------------------------------------------- /library/src/main/java/news/androidtv/filepicker/filters/FilterInterface.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker.filters; 2 | 3 | import news.androidtv.filepicker.model.AbstractFile; 4 | 5 | /** 6 | * Created by Nick on 9/21/2016. 7 | */ 8 | public interface FilterInterface { 9 | /** 10 | * Checks if the provided {@link AbstractFile} matches the filter's parameters 11 | * @param file The file to check 12 | * @return true if the filter matches. Otherwise the file will not be shown. 13 | */ 14 | boolean matches(AbstractFile file); 15 | 16 | /** 17 | * Returns a short description of what this filter is trying to find, to be displayed to the 18 | * user. 19 | * @return A short, three to four word description. 20 | */ 21 | String getDescription(); 22 | } 23 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 12 | 13 | 17 | 18 | -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | 7 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /app/src/androidTest/java/news/androidtv/filepicker/ExampleInstrumentedTest.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker; 2 | 3 | import android.content.Context; 4 | import android.support.test.InstrumentationRegistry; 5 | import android.support.test.runner.AndroidJUnit4; 6 | 7 | import org.junit.Test; 8 | import org.junit.runner.RunWith; 9 | 10 | import static org.junit.Assert.*; 11 | 12 | /** 13 | * Instrumentation test, which will execute on an Android device. 14 | * 15 | * @see Testing documentation 16 | */ 17 | @RunWith(AndroidJUnit4.class) 18 | public class ExampleInstrumentedTest { 19 | @Test 20 | public void useAppContext() throws Exception { 21 | // Context of the app under test. 22 | Context appContext = InstrumentationRegistry.getTargetContext(); 23 | 24 | assertEquals("news.androidtv.filepicker", appContext.getPackageName()); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /library/src/androidTest/java/news/androidtv/filepicker/ExampleInstrumentedTest.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker; 2 | 3 | import android.content.Context; 4 | import android.support.test.InstrumentationRegistry; 5 | import android.support.test.runner.AndroidJUnit4; 6 | 7 | import org.junit.Test; 8 | import org.junit.runner.RunWith; 9 | 10 | import static org.junit.Assert.*; 11 | 12 | /** 13 | * Instrumentation test, which will execute on an Android device. 14 | * 15 | * @see Testing documentation 16 | */ 17 | @RunWith(AndroidJUnit4.class) 18 | public class ExampleInstrumentedTest { 19 | @Test 20 | public void useAppContext() throws Exception { 21 | // Context of the app under test. 22 | Context appContext = InstrumentationRegistry.getTargetContext(); 23 | 24 | assertEquals("news.androidtv.filepicker.test", appContext.getPackageName()); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /library/src/main/java/news/androidtv/filepicker/filters/FileExtensionFilter.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker.filters; 2 | 3 | import news.androidtv.filepicker.model.AbstractFile; 4 | 5 | /** 6 | * This filter makes it easy to match with files that have a given file extension. 7 | */ 8 | public class FileExtensionFilter implements FilterInterface { 9 | private String mFileExtension; 10 | 11 | /** 12 | * Creates a new instance of a FileExtensionFilter 13 | * 14 | * @param fileExtension The file extension to be selected, without a period. 15 | */ 16 | public FileExtensionFilter(String fileExtension) { 17 | mFileExtension = fileExtension; 18 | } 19 | 20 | @Override 21 | public boolean matches(AbstractFile file) { 22 | return file.getFileExtension().equals(mFileExtension) || file.isDirectory(); 23 | } 24 | 25 | @Override 26 | public String getDescription() { 27 | return "Select a " + mFileExtension + " file"; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /library/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.library' 2 | 3 | android { 4 | compileSdkVersion 24 5 | buildToolsVersion "24.0.0" 6 | 7 | defaultConfig { 8 | minSdkVersion 21 9 | targetSdkVersion 24 10 | versionCode 1 11 | versionName "1.0" 12 | 13 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 14 | 15 | } 16 | buildTypes { 17 | release { 18 | minifyEnabled false 19 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 20 | } 21 | } 22 | } 23 | 24 | dependencies { 25 | compile fileTree(dir: 'libs', include: ['*.jar']) 26 | androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', { 27 | exclude group: 'com.android.support', module: 'support-annotations' 28 | }) 29 | compile 'com.android.support:appcompat-v7:24.2.1' 30 | compile 'com.android.support:leanback-v17:24.2.1' 31 | testCompile 'junit:junit:4.12' 32 | } 33 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.application' 2 | 3 | android { 4 | compileSdkVersion 24 5 | buildToolsVersion "24.0.0" 6 | defaultConfig { 7 | applicationId "news.androidtv.samples.filepicker" 8 | minSdkVersion 21 9 | targetSdkVersion 24 10 | versionCode 1 11 | versionName "1.0" 12 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 13 | } 14 | buildTypes { 15 | release { 16 | minifyEnabled false 17 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 18 | } 19 | } 20 | } 21 | 22 | dependencies { 23 | compile project(':library') 24 | compile fileTree(dir: 'libs', include: ['*.jar']) 25 | androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', { 26 | exclude group: 'com.android.support', module: 'support-annotations' 27 | }) 28 | compile 'com.android.support:appcompat-v7:24.2.1' 29 | testCompile 'junit:junit:4.12' 30 | } 31 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 19 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 46 | 47 | 48 | 49 | 50 | 1.7 51 | 52 | 57 | 58 | 59 | 60 | 61 | 62 | -------------------------------------------------------------------------------- /app/src/main/java/news/androidtv/samples/filepicker/MainActivity.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.samples.filepicker; 2 | 3 | import android.Manifest; 4 | import android.app.FragmentTransaction; 5 | import android.os.Build; 6 | import android.os.Bundle; 7 | import android.os.Environment; 8 | import android.support.annotation.NonNull; 9 | import android.support.v4.content.PermissionChecker; 10 | import android.support.v7.app.AppCompatActivity; 11 | import android.util.Log; 12 | import android.widget.Toast; 13 | 14 | import news.androidtv.filepicker.FilePickerFragment; 15 | import news.androidtv.filepicker.filters.FileExtensionFilter; 16 | import news.androidtv.filepicker.model.AbstractFile; 17 | 18 | public class MainActivity extends AppCompatActivity { 19 | private static final String TAG = MainActivity.class.getSimpleName(); 20 | 21 | private static final int PERMISSION_READ = 100; 22 | 23 | @Override 24 | protected void onCreate(Bundle savedInstanceState) { 25 | super.onCreate(savedInstanceState); 26 | setContentView(R.layout.activity_main); 27 | } 28 | 29 | @Override 30 | protected void onStart() { 31 | super.onStart(); 32 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M && 33 | PermissionChecker.checkSelfPermission(this, 34 | Manifest.permission.READ_EXTERNAL_STORAGE) 35 | == PermissionChecker.PERMISSION_GRANTED) { 36 | startFilePickerFragment(); 37 | } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) { 38 | requestPermissions(new String[] {Manifest.permission.READ_EXTERNAL_STORAGE}, 39 | PERMISSION_READ); 40 | } else { 41 | startFilePickerFragment(); 42 | } 43 | } 44 | 45 | @Override 46 | public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, 47 | @NonNull int[] grantResults) { 48 | super.onRequestPermissionsResult(requestCode, permissions, grantResults); 49 | startFilePickerFragment(); 50 | } 51 | 52 | private void startFilePickerFragment() { 53 | Log.d(TAG, "Start file picker"); 54 | FilePickerFragment filePickerFragment = FilePickerFragment.newInstance(this, 55 | AbstractFile.fromLocalPath(Environment.getExternalStorageDirectory()), 56 | new FileExtensionFilter("png"), new FilePickerFragment.SelectionCallback() { 57 | @Override 58 | public boolean onFilePicked(FilePickerFragment filePickerFragment, 59 | AbstractFile abstractFile) { 60 | Toast.makeText(MainActivity.this, "User selected " + abstractFile.getUri(), 61 | Toast.LENGTH_SHORT).show(); 62 | return true; 63 | } 64 | 65 | @Override 66 | public boolean onDirectoryPicked(FilePickerFragment filePickerFragment, 67 | AbstractFile abstractDirectory) { 68 | return filePickerFragment.explore( 69 | AbstractFile.fromLocalAbstractFile(abstractDirectory)); 70 | } 71 | }); 72 | FragmentTransaction transaction = getFragmentManager().beginTransaction(); 73 | transaction.add(android.R.id.content, filePickerFragment, "root"); 74 | transaction.commit(); 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /library/src/main/java/news/androidtv/filepicker/model/AbstractFile.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker.model; 2 | 3 | import android.net.Uri; 4 | 5 | import java.io.File; 6 | import java.util.ArrayList; 7 | import java.util.List; 8 | 9 | /** 10 | *

An abstract representation of a file with a few simple properties. This class cannot be 11 | * created on its own. It is meant to be subclassed and implemented with a variety of different 12 | * file-based implementations, locally and through the cloud.

13 | * 14 | *

There are some static methods, such as {@link #fromFile(File)} which can create an 15 | * AbstractFilefrom a local file, although this class was designed to work with other types of file 16 | * structures where a {@link File} may not exist or be accessible.

17 | */ 18 | public class AbstractFile { 19 | protected boolean mIsDirectory; 20 | protected String mTitle; 21 | protected Uri mUri; 22 | protected AbstractFile parent; 23 | protected AbstractFile[] mDirectoryFiles; 24 | 25 | protected AbstractFile() { 26 | } 27 | 28 | /** 29 | * Returns whether this is a directory, folder, or collection of files. 30 | * 31 | * @return true if this is not a file, but a directory of files 32 | */ 33 | public boolean isDirectory() { 34 | return mIsDirectory; 35 | } 36 | 37 | /** 38 | * Returns the display name for this file. This may be the folder or file name without the 39 | * entire file path. 40 | * 41 | * @return The displayed name for this file. 42 | */ 43 | public String getTitle() { 44 | return mTitle; 45 | } 46 | 47 | /** 48 | * Returns the Uri for this file. This may be the absolute file path name for this file, or 49 | * some other type of pointer depending on the implementation. 50 | * 51 | * @return The Uri for the file. 52 | */ 53 | public Uri getUri() { 54 | return mUri; 55 | } 56 | 57 | /** 58 | * For a directory, returns a list of AbstractFiles. 59 | * 60 | * @return The list of AbstractFiles found inside a directory. If this is not a directory, null 61 | * will be returned. 62 | */ 63 | public AbstractFile[] getFiles() { 64 | if (mIsDirectory) { 65 | return mDirectoryFiles; 66 | } 67 | return null; 68 | } 69 | 70 | /** 71 | * Returns the parent directory for this file if possible. 72 | * 73 | * @return An AbstractFile which represents the directory this file is in. 74 | */ 75 | public AbstractFile getParent() { 76 | return parent; 77 | } 78 | 79 | /** 80 | * Returns the type of file this is. This can be overriden for a specific purpose. Its default 81 | * implementation will check the last section of the file's title and use that. 82 | * 83 | * @return The file extension for the file. 84 | */ 85 | public String getFileExtension() { 86 | String[] uriArray = mTitle.split("[.]"); 87 | return uriArray[uriArray.length-1]; 88 | } 89 | 90 | /** 91 | * Passing a local folder from the device will allow a list of files to be instantiated with 92 | * default parameters. 93 | * 94 | * @param filePath The local file path to convert 95 | * @return A list of AbstractFiles representing the contents of this folder. 96 | */ 97 | public static AbstractFile fromLocalPath(File filePath) { 98 | List abstractFileList = new ArrayList<>(); 99 | AbstractFile abstractFile = fromFile(filePath); 100 | if (filePath.listFiles() != null) { 101 | for (File file : filePath.listFiles()) { 102 | AbstractFile childFile = fromFile(file); 103 | childFile.parent = abstractFile; 104 | abstractFileList.add(childFile); 105 | } 106 | } 107 | abstractFile.mDirectoryFiles = 108 | abstractFileList.toArray(new AbstractFile[abstractFileList.size()]); 109 | return abstractFile; 110 | } 111 | 112 | /** 113 | * Creates a new AbstractFile based on the attributes of the provided File object. 114 | * 115 | * @param file The file to be converted. 116 | * @return An AbstractFile representing the file. 117 | */ 118 | public static AbstractFile fromFile(File file) { 119 | AbstractFile abstractFile = new AbstractFile(); 120 | abstractFile.mIsDirectory = file.isDirectory(); 121 | abstractFile.mTitle = file.getName(); 122 | abstractFile.mUri = Uri.parse(file.getAbsolutePath()); 123 | return abstractFile; 124 | } 125 | 126 | /** 127 | * When a directory is provided, this will open that directory based on {@link #getUri()} and 128 | * return a list of AbstractFiles from that directory. 129 | * 130 | * @param directory The directory to explore, as an AbstractFile. 131 | * @return A list of AbstractFiles representing the contents of this folder. 132 | */ 133 | public static AbstractFile fromLocalAbstractFile(AbstractFile directory) { 134 | File directoryFile = new File(String.valueOf(directory.getUri())); 135 | AbstractFile abstractDirectory = fromLocalPath(directoryFile); 136 | if (directoryFile.getParentFile() != null) { 137 | abstractDirectory.parent = fromFile(directoryFile.getParentFile()); 138 | } 139 | return abstractDirectory; 140 | } 141 | } 142 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # Attempt to set APP_HOME 46 | # Resolve links: $0 may be a link 47 | PRG="$0" 48 | # Need this for relative symlinks. 49 | while [ -h "$PRG" ] ; do 50 | ls=`ls -ld "$PRG"` 51 | link=`expr "$ls" : '.*-> \(.*\)$'` 52 | if expr "$link" : '/.*' > /dev/null; then 53 | PRG="$link" 54 | else 55 | PRG=`dirname "$PRG"`"/$link" 56 | fi 57 | done 58 | SAVED="`pwd`" 59 | cd "`dirname \"$PRG\"`/" >/dev/null 60 | APP_HOME="`pwd -P`" 61 | cd "$SAVED" >/dev/null 62 | 63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 64 | 65 | # Determine the Java command to use to start the JVM. 66 | if [ -n "$JAVA_HOME" ] ; then 67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 68 | # IBM's JDK on AIX uses strange locations for the executables 69 | JAVACMD="$JAVA_HOME/jre/sh/java" 70 | else 71 | JAVACMD="$JAVA_HOME/bin/java" 72 | fi 73 | if [ ! -x "$JAVACMD" ] ; then 74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 75 | 76 | Please set the JAVA_HOME variable in your environment to match the 77 | location of your Java installation." 78 | fi 79 | else 80 | JAVACMD="java" 81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 82 | 83 | Please set the JAVA_HOME variable in your environment to match the 84 | location of your Java installation." 85 | fi 86 | 87 | # Increase the maximum file descriptors if we can. 88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 89 | MAX_FD_LIMIT=`ulimit -H -n` 90 | if [ $? -eq 0 ] ; then 91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 92 | MAX_FD="$MAX_FD_LIMIT" 93 | fi 94 | ulimit -n $MAX_FD 95 | if [ $? -ne 0 ] ; then 96 | warn "Could not set maximum file descriptor limit: $MAX_FD" 97 | fi 98 | else 99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 100 | fi 101 | fi 102 | 103 | # For Darwin, add options to specify how the application appears in the dock 104 | if $darwin; then 105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 106 | fi 107 | 108 | # For Cygwin, switch paths to Windows format before running java 109 | if $cygwin ; then 110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 112 | JAVACMD=`cygpath --unix "$JAVACMD"` 113 | 114 | # We build the pattern for arguments to be converted via cygpath 115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 116 | SEP="" 117 | for dir in $ROOTDIRSRAW ; do 118 | ROOTDIRS="$ROOTDIRS$SEP$dir" 119 | SEP="|" 120 | done 121 | OURCYGPATTERN="(^($ROOTDIRS))" 122 | # Add a user-defined pattern to the cygpath arguments 123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 125 | fi 126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 127 | i=0 128 | for arg in "$@" ; do 129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 131 | 132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 134 | else 135 | eval `echo args$i`="\"$arg\"" 136 | fi 137 | i=$((i+1)) 138 | done 139 | case $i in 140 | (0) set -- ;; 141 | (1) set -- "$args0" ;; 142 | (2) set -- "$args0" "$args1" ;; 143 | (3) set -- "$args0" "$args1" "$args2" ;; 144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 150 | esac 151 | fi 152 | 153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 154 | function splitJvmOpts() { 155 | JVM_OPTS=("$@") 156 | } 157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 159 | 160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 161 | -------------------------------------------------------------------------------- /library/src/main/java/news/androidtv/filepicker/FilePickerFragment.java: -------------------------------------------------------------------------------- 1 | package news.androidtv.filepicker; 2 | 3 | import android.annotation.SuppressLint; 4 | import android.app.Activity; 5 | import android.os.Bundle; 6 | import android.support.annotation.NonNull; 7 | import android.support.v17.leanback.app.GuidedStepFragment; 8 | import android.support.v17.leanback.widget.GuidanceStylist; 9 | import android.support.v17.leanback.widget.GuidedAction; 10 | 11 | import java.util.List; 12 | 13 | import news.androidtv.filepicker.filters.FilterInterface; 14 | import news.androidtv.filepicker.model.AbstractFile; 15 | 16 | /** 17 | *

This class extends the {@link GuidedStepFragment} to provide a simple file browser that is 18 | * native to Android TV and a DPAD interface. In your activity, you should initialize the picker 19 | * by calling {@link #newInstance(Activity, AbstractFile, FilterInterface, SelectionCallback)}. 20 | *

21 | * 22 | *

This method is robust, allowing for a wide range of customization depending on the 23 | * implementation. It can display an array of {@link AbstractFile} that can have any origin. To 24 | * match with a certain type of file, or just selecting a folder, a class implementing 25 | * {@link FilterInterface} can be provided. Then, the developer can customize the response by 26 | * providing a {@link SelectionCallback}. 27 | *

28 | */ 29 | public class FilePickerFragment extends GuidedStepFragment { 30 | private AbstractFile mFiles; 31 | private Activity mActivity; 32 | private FilterInterface mFilterInterface; 33 | private SelectionCallback mSelectionCallback; 34 | 35 | @SuppressLint("ValidFragment") 36 | private FilePickerFragment() { 37 | } 38 | 39 | /** 40 | * Creates a new instance of the {@link FilePickerFragment} with a set of parameters. 41 | * 42 | * @param attachedActivity The activity that owns this fragment. 43 | * @param files A list of {@link AbstractFile} that will be shown. 44 | * @param filterInterface A filter to indicate which types of files should be shown. 45 | * @param callback A callback which will be run when a user selects a particular item. 46 | * @return A root FilePickerFragment. 47 | */ 48 | public static FilePickerFragment newInstance(Activity attachedActivity, AbstractFile files, 49 | @NonNull FilterInterface filterInterface, @NonNull SelectionCallback callback) { 50 | FilePickerFragment filePickerFragment = new FilePickerFragment(); 51 | filePickerFragment.mActivity = attachedActivity; 52 | filePickerFragment.mFiles = files; 53 | filePickerFragment.mFilterInterface = filterInterface; 54 | filePickerFragment.mSelectionCallback = callback; 55 | return filePickerFragment; 56 | } 57 | 58 | /** 59 | * Creates a list of Folders. 60 | * 61 | * @param actions The list of {@link GuidedAction} that will be created. 62 | * @param savedInstanceState We don't use this. 63 | */ 64 | @Override 65 | public void onCreateActions(@NonNull List actions, Bundle savedInstanceState) { 66 | if (mFiles.getParent() != null) { 67 | actions.add(new GuidedAction.Builder(mActivity) 68 | .icon(mActivity.getDrawable(R.drawable.ic_folder_white_24dp)) 69 | .id(-1) 70 | .title("../") // Go up one step 71 | .build()); 72 | } 73 | if (mFiles.getFiles() != null) { 74 | for (int i = 0; i < mFiles.getFiles().length; i++) { 75 | AbstractFile file = mFiles.getFiles()[i]; 76 | if (file.isDirectory() && mFilterInterface.matches(file)) { 77 | actions.add(new GuidedAction.Builder(mActivity) 78 | .icon(mActivity.getDrawable(R.drawable.ic_folder_white_24dp)) 79 | .id(i) 80 | .title(file.getTitle()) 81 | .build()); 82 | } 83 | } 84 | } 85 | } 86 | 87 | @Override 88 | public void onGuidedActionClicked(GuidedAction action) { 89 | if (action.getId() == -1) { 90 | // Selected the up directory 91 | explore(AbstractFile.fromLocalAbstractFile(mFiles.getParent())); 92 | return; 93 | } 94 | AbstractFile selectedFile = mFiles.getFiles()[(int) action.getId()]; 95 | if (selectedFile.isDirectory()) { 96 | if (mSelectionCallback.onDirectoryPicked(this, selectedFile)) { 97 | closeFilePickerFragment(); 98 | } 99 | } else { 100 | if (mSelectionCallback.onFilePicked(this, selectedFile)) { 101 | closeFilePickerFragment(); 102 | } 103 | } 104 | } 105 | 106 | /** 107 | * Create a list of Files. 108 | * 109 | * @param actions The list of {@link GuidedAction} that will be created. 110 | * @param savedInstanceState We don't use this. 111 | */ 112 | @Override 113 | public void onCreateButtonActions(@NonNull List actions, 114 | Bundle savedInstanceState) { 115 | if (mFiles.getFiles() != null) { 116 | for (int i = 0; i < mFiles.getFiles().length; i++) { 117 | AbstractFile file = mFiles.getFiles()[i]; 118 | if (!file.isDirectory() && mFilterInterface.matches(file)) { 119 | actions.add(new GuidedAction.Builder(mActivity) 120 | .id(i) 121 | .title(file.getTitle()) 122 | .build()); 123 | } 124 | } 125 | } 126 | } 127 | 128 | @Override 129 | public int onProvideTheme() { 130 | return R.style.Theme_Leanback_GuidedStep; 131 | } 132 | 133 | @Override 134 | public void setUiStyle(int style) { 135 | super.setUiStyle(UI_STYLE_ACTIVITY_ROOT); 136 | } 137 | 138 | @NonNull 139 | @Override 140 | public GuidanceStylist.Guidance onCreateGuidance(Bundle savedInstanceState) { 141 | return new GuidanceStylist.Guidance("File Browser", mFiles.getUri().toString(), 142 | mFilterInterface.getDescription(), mActivity.getApplication().getApplicationInfo() 143 | .loadIcon(mActivity.getPackageManager())); 144 | 145 | } 146 | 147 | /** 148 | * Closes the file picker. 149 | */ 150 | public void closeFilePickerFragment() { 151 | finishGuidedStepFragments(); 152 | } 153 | 154 | /** 155 | * Adds another layer to the FilePicker layer instead of creating an entirely new instance. This 156 | * keeps the same filter and callback. 157 | * 158 | * @param files The new list of files to browse. 159 | * @return Returns false to be used in a simple, single line in 160 | * {@link SelectionCallback#onDirectoryPicked(FilePickerFragment, AbstractFile)}. 161 | */ 162 | public boolean explore(AbstractFile files) { 163 | GuidedStepFragment.add(mActivity.getFragmentManager(), newInstance(mActivity, files, 164 | mFilterInterface, mSelectionCallback)); 165 | return false; 166 | } 167 | 168 | public interface SelectionCallback { 169 | /** 170 | * This method is called when the user has selected a file in the file picker. 171 | * 172 | * @param filePickerFragment The current fragment, to access helper methods such as 173 | * {@link #explore(AbstractFile)} 174 | * @param abstractFile The file that was selected. 175 | * @return true if the file picker should be closed. False if it should remain open. 176 | */ 177 | boolean onFilePicked(FilePickerFragment filePickerFragment, AbstractFile abstractFile); 178 | /** 179 | * This method is called when the user has selected a directory in the file picker. 180 | * 181 | * @param filePickerFragment The current fragment, to access helper methods such as 182 | * {@link #explore(AbstractFile)} 183 | * @param abstractDirectory The directory that was selected. 184 | * @return true if the file picker should be closed. False if it should remain open. 185 | */ 186 | boolean onDirectoryPicked(FilePickerFragment filePickerFragment, 187 | AbstractFile abstractDirectory); 188 | } 189 | } 190 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------