com.carlomicieli.jtrains.value.constants.Visibility.java Source code

Introduction

Here is the source code for com.carlomicieli.jtrains.value.constants.Visibility.java

Source

/*
 * Copyright 2014 the original author or authors.
 *
 *  Licensed under the Apache License, Version 2.0 (the 'License');
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an 'AS IS' BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.carlomicieli.jtrains.value.constants;

import com.carlomicieli.jtrains.util.EnumUtils;
import org.apache.commons.lang.StringUtils;

/**
 * The content visibility enum.
 *
 * @author Carlo Micieli
 * @since 1.0
 */
public enum Visibility {
    /**
     * Everyone can see this item.
     */
    PUBLIC,

    /**
     * Nobody but the owner can see this item.
     */
    PRIVATE;

    /**
     * Gets the {@code Visibility} keyword
     *
     * @return the keyword
     */
    public String label() {
        return EnumUtils.keyFor(this);
    }

    /**
     * Parses the string argument as a {@code Visibility}.
     *
     * @param vis the string to be parsed
     * @return a {@code Visibility} value
     */
    public static Visibility parse(String vis) {
        return EnumUtils.parseEnum(Visibility.class, vis);
    }

    /**
     * Parses the string argument as a {@code Visibility}.
     *
     * @param vis        the string to be parsed
     * @param defaultVis the default {@code Visibility} value
     * @return a {@code Visibility} value
     */
    public static Visibility parse(String vis, Visibility defaultVis) {
        if (StringUtils.isBlank(vis)) {
            return defaultVis;
        }
        return EnumUtils.parseEnum(Visibility.class, vis);
    }
}