org.ambraproject.wombat.feed.FeedMetadataField.java Source code

Introduction

Here is the source code for org.ambraproject.wombat.feed.FeedMetadataField.java

Source

/*
 * Copyright (c) 2017 Public Library of Science
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

package org.ambraproject.wombat.feed;

import com.google.common.base.CaseFormat;
import org.springframework.ui.Model;
import org.springframework.web.servlet.ModelAndView;

import java.util.Map;

/**
 * Values passed into a Spring model to describe the feed.
 */
public enum FeedMetadataField {
    // Required
    SITE, FEED_INPUT,

    // Optional
    ID, TIMESTAMP, TITLE, DESCRIPTION, LINK, IMAGE;

    private String getKey() {
        return CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, name());
    }

    public Object getFrom(Map<String, Object> model) {
        return model.get(getKey());
    }

    public Object putInto(Map<String, Object> model, Object value) {
        return model.put(getKey(), value);
    }

    public Object putInto(Model model, Object value) {
        return putInto(model.asMap(), value);
    }

    public Object putInto(ModelAndView mav, Object value) {
        return putInto(mav.getModel(), value);
    }

}