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 024/** 025 * Visibility controls whether a certain {@link cascading.management.annotation.Property} is visible to a certain 026 * audience. 027 * <ul> 028 * <li>{@link #PRIVATE} - recommended that only a developer or team/project member have access to the value</li> 029 * <li>{@link #PROTECTED} - recommended for interested and authorized parties</li> 030 * <li>{@link #PUBLIC} - recommended for use as general purpose information</li> 031 * </ul> 032 * <p> 033 * Note {@link cascading.tap.Tap#getIdentifier()} defines the {@link cascading.management.annotation.Sanitizer} 034 * implementation {@link cascading.management.annotation.URISanitizer} which attempts to cleanse the URI identifier 035 * for each of the above visibilities. 036 * <p> 037 * It is up to the implementation of a {@link cascading.management.DocumentService} to interpret and use these 038 * values. 039 * <p> 040 * Cascading does not enforce any restrictions related to the values, they are considered informative. 041 * <p> 042 * To prevent serialization of any value via the registered {@link cascading.management.DocumentService}, do not 043 * mark a field with the Property annotation, or configure the service appropriately. 044 */ 045public enum Visibility 046 { 047 PRIVATE, 048 PROTECTED, 049 PUBLIC 050 }