001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2006-2008 Sun Microsystems, Inc. 025 * Portions Copyright 2015 ForgeRock AS. 026 */ 027package org.opends.server.types; 028 029 030 031/** 032 * This enumeration defines the set of possible behaviors that should 033 * be taken when attempting to write to a file that already exists. 034 */ 035@org.opends.server.types.PublicAPI( 036 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED, 037 mayInstantiate=false, 038 mayExtend=false, 039 mayInvoke=true) 040public enum ExistingFileBehavior 041{ 042 /** 043 * The file behavior that indicates that the data written should be 044 * appended to any existing file. 045 */ 046 APPEND("append"), 047 048 049 050 /** 051 * The file behavior that indicates that the data written should 052 * overwrite any existing file. 053 */ 054 OVERWRITE("overwrite"), 055 056 057 058 /** 059 * The file behavior that indicates that the write should fail if 060 * the specified file already exists. 061 */ 062 FAIL("fail"); 063 064 065 066 /** The name to use for this existing file behavior. */ 067 private String name; 068 069 070 071 /** 072 * Creates a new existing file behavior with the specified name. 073 * 074 * @param name The name for this existing file behavior. 075 */ 076 private ExistingFileBehavior(String name) 077 { 078 this.name = name; 079 } 080 081 082 083 /** 084 * Retrieves the name for this existing file behavior. 085 * 086 * @return The name for this existing file behavior. 087 */ 088 public String getName() 089 { 090 return name; 091 } 092 093 094 095 /** 096 * Retrieves a string representation of this existing file behavior. 097 * 098 * @return A string representation of this existing file behavior. 099 */ 100 public String toString() 101 { 102 return name; 103 } 104} 105