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
021package cascading.management.annotation;
022
023import java.lang.annotation.ElementType;
024import java.lang.annotation.Retention;
025import java.lang.annotation.RetentionPolicy;
026import java.lang.annotation.Target;
027
028/**
029 * PropertyOrder is an annotation at the class level that controls the sort order of the Property annotations present
030 * on that class.
031 * </p>
032 * Order.DECLARED is the default sort order in which the properties are returned in the order they are returned by the
033 * reflection API of the JVM. This can be implementation specific and is not guaranteed to be stable.
034 * <p/>
035 * Using Order.ALPHABETICAL will cause the properties to be sorted alphabetically.
036 * <p/>
037 * Order.GIVEN and an array of Strings containing <em>all</em> properties of that class, will result in a custom order.
038 */
039@Retention(RetentionPolicy.RUNTIME)
040@Target(ElementType.TYPE)
041public @interface PropertyOrder
042  {
043  Order order() default Order.DECLARED;
044
045  String[] properties() default {};
046  }