com.sdl.dxa.common.util.MvcUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dxa-common Show documentation

DXA Common project contains framework common classes shared between all other artifacts

There is a newer version: 2.3.7

package com.sdl.dxa.common.util;

import com.google.common.base.Splitter;
import com.sdl.dxa.api.datamodel.model.MvcModelData;
import com.sdl.webapp.common.util.StringUtils;

import java.util.List;

/**
 * MVC utils to work with String MVC Data.
 *
 */
public final class MvcUtils {

    private MvcUtils() {
    }

    /**
     * Builds a {@link MvcModelData} from a qualified view name.
     *
     * @param qualifiedViewName fully qualified name in a defined format. Format must be 'ViewName'
     *                          or 'AreaName:ViewName' or 'AreaName:ControllerName:ViewName.'
     * @return a {@link MvcModelData} with existing fields initiated
     * @throws IllegalArgumentException if format is wrong
     */
    public static MvcModelData parseMvcQualifiedViewName(String qualifiedViewName) {
        return parseMvcQualifiedViewName(qualifiedViewName, true);
    }

    /**
     * Builds a {@link MvcModelData} from a qualified view name.
     *
     * @param qualifiedViewName    fully qualified name in a defined format. Format must be 'ViewName'
     *                             or 'AreaName:ViewName' or 'AreaName:ControllerName:ViewName.'
     * @param replaceSpaceWithDash defines if spaces in ViewName need to be replaced with '-'
     * @return a {@link MvcModelData} with existing fields initiated
     * @throws IllegalArgumentException if format is wrong
     */
    public static MvcModelData parseMvcQualifiedViewName(String qualifiedViewName, boolean replaceSpaceWithDash) {
        List parts = Splitter.on(":").omitEmptyStrings().splitToList(replaceSpaceWithDash ? StringUtils.dashify(qualifiedViewName) : qualifiedViewName);

        MvcModelData.MvcModelDataBuilder builder = MvcModelData.builder();
        switch (parts.size()) {
            case 1:
                builder.viewName(parts.get(0));
                break;
            case 2:
                builder.areaName(parts.get(0)).viewName(parts.get(1));
                break;
            case 3:
                builder.areaName(parts.get(0)).controllerName(parts.get(1)).viewName(parts.get(2));
                break;
            default:
                throw new IllegalArgumentException(
                        String.format("Invalid format for Qualified View Name: '%s'. " +
                                "Format must be 'ViewName' or 'AreaName:ViewName' " +
                                "or 'AreaName:ControllerName:ViewName.'", qualifiedViewName));
        }
        return builder.build();
    }
}