001    /*
002     * Copyright (c) 2007-2015 Concurrent, Inc. All Rights Reserved.
003     *
004     * Project and contact information: http://www.cascading.org/
005     *
006     * This file is part of the Cascading project.
007     *
008     * Licensed under the Apache License, Version 2.0 (the "License");
009     * you may not use this file except in compliance with the License.
010     * You may obtain a copy of the License at
011     *
012     *     http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing, software
015     * distributed under the License is distributed on an "AS IS" BASIS,
016     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017     * See the License for the specific language governing permissions and
018     * limitations under the License.
019     */
020    
021    package cascading.management.annotation;
022    
023    import java.lang.annotation.ElementType;
024    import java.lang.annotation.Retention;
025    import java.lang.annotation.RetentionPolicy;
026    import java.lang.annotation.Target;
027    
028    /**
029     * Property annotations can be used to send additional information about certain aspects of Cascading classes
030     * to the {@link cascading.management.DocumentService}.  The properties are present at runtime and allow a
031     * DocumentService to inspect, process or persist them.
032     * <p/>
033     * Property annotations can be applied to {@link cascading.tap.Tap}s, {@link cascading.scheme.Scheme}s,
034     * {@link cascading.flow.Flow}s, {@link cascading.operation.Function}s and {@link cascading.operation.Filter}s.
035     * <p/>
036     *
037     * @Property annotations can be applied to public methods and public fields, so that they can be accessed via
038     * java.lang.Class#getMethods() and java.lang.Class.getFields() respectively. Adding @Property annotations on any
039     * non-public method or field will have no effect.
040     */
041    @Retention(RetentionPolicy.RUNTIME)
042    @Target({ElementType.METHOD, ElementType.FIELD})
043    public @interface Property
044      {
045      String name();
046    
047      Visibility visibility();
048      }