001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2010-2011 ApexIdentity Inc.
015 * Portions Copyright 2011-2014 ForgeRock AS.
016 */
017
018package org.forgerock.openig.text;
019
020/**
021 * Commonly used field separator specifications.
022 */
023public enum Separators {
024
025    /** Unix-style colon separated values, with backslash escape character. */
026    COLON(new Separator(':', -1, '\\')),
027
028    /** Comma separated values, with support for quoted literal strings. */
029    COMMA(new Separator(',', '"', -1)),
030
031    /** Tab separated values, with support for quoted literal strings. */
032    TAB(new Separator('\t', '"', -1));
033
034    /** The separator specification that the enum constant represents. */
035    private final Separator separator;
036
037    /**
038     * Constructs a new separator constant with the specified separator specification.
039     *
040     * @param separator
041     *         specified separator specification
042     */
043    Separators(Separator separator) {
044        this.separator = separator;
045    }
046
047    /**
048     * Returns the {@link Separator} specification that the enum constant represents.
049     * @return the {@link Separator} specification that the enum constant represents.
050     */
051    public Separator getSeparator() {
052        return separator;
053    }
054}