net.simonvt.schematic.annotation.ContentProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of schematic-annotations Show documentation

Automatically generate ContentProviders

The newest version!

/*
 * Copyright (C) 2014 Simon Vig Therkildsen
 *
 * 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.
 */

package net.simonvt.schematic.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.CLASS;

/**
 * The class annotated describes a ContentProvider. For each table in the database, add a {@link
 * net.simonvt.schematic.annotation.TableEndpoint} annotation to an inner class.
 * {@code
 * @ContentProvider(authority = NotesProvider.AUTHORITY, database = NotesDatabase.class)
 * public final class NotesProvider {
 *
 *   @TableEndpoint(table = NotesDatabase.LISTS) public static class Lists {
 *     ...
 *   }
 * }
 * }
 */
@Retention(CLASS) @Target(TYPE)
public @interface ContentProvider {
  String name() default "";

  String packageName() default "";

  String authority();

  Class database();
}