001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019package org.apache.isis.viewer.restfulobjects.applib;
020
021/**
022 * Enumerates the organization that defined a {@link Rel}.
023 */
024public enum RelDefinition {
025
026    /**
027     * {@link Rel} defined by IANA.
028     */
029    IANA(null, false),
030    /**
031     * {@link Rel} defined by the Restful Objects spec.
032     */
033    RO_SPEC("urn:org.restfulobjects:rels/", true),
034    /**
035     * Proprietary rel defined by implementation.
036     */
037    IMPL("urn:org.apache.isis.restfulobjects:rels/", true);
038    
039    private final String relPrefix;
040    private final boolean addParams;
041
042    private RelDefinition(String relPrefix, boolean canAddParams) {
043        this.relPrefix = relPrefix;
044        this.addParams = canAddParams;
045    }
046    
047    public String nameOf(String relSuffix) {
048        return (relPrefix != null? relPrefix:"") +relSuffix;
049    }
050    public boolean canAddParams() {
051        return addParams;
052    }
053}