001/*
002 * Copyright (c) 2016-2017 Chris K Wensel <chris@wensel.net>. All Rights Reserved.
003 * Copyright (c) 2007-2017 Xplenty, Inc. All Rights Reserved.
004 *
005 * Project and contact information: http://www.cascading.org/
006 *
007 * This file is part of the Cascading project.
008 *
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *     http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 */
021
022package cascading.management.annotation;
023
024import java.lang.annotation.ElementType;
025import java.lang.annotation.Retention;
026import java.lang.annotation.RetentionPolicy;
027import java.lang.annotation.Target;
028
029/**
030 * PropertyOrder is an annotation at the class level that controls the sort order of the Property annotations present
031 * on that class.
032 * <p>
033 * Order.DECLARED is the default sort order in which the properties are returned in the order they are returned by the
034 * reflection API of the JVM. This can be implementation specific and is not guaranteed to be stable.
035 * <p>
036 * Using Order.ALPHABETICAL will cause the properties to be sorted alphabetically.
037 * <p>
038 * Order.GIVEN and an array of Strings containing <em>all</em> properties of that class, will result in a custom order.
039 */
040@Retention(RetentionPolicy.RUNTIME)
041@Target(ElementType.TYPE)
042public @interface PropertyOrder
043  {
044  Order order() default Order.DECLARED;
045
046  String[] properties() default {};
047  }