FieldAliasingMapper.java

/*
 * Copyright (C) 2005 Joe Walnes.
 * Copyright (C) 2006, 2007, 2008, 2009, 2013, 2014, 2015, 2016, 2024 XStream Committers.
 * All rights reserved.
 *
 * The software in this package is published under the terms of the BSD
 * style license a copy of which has been included with this distribution in
 * the LICENSE.txt file.
 *
 * Created on 09. April 2005 by Joe Walnes
 */
package com.thoughtworks.xstream.mapper;

import java.util.regex.Pattern;

import com.thoughtworks.xstream.core.util.MemberStore;


/**
 * Mapper that allows a field of a specific class to be replaced with a shorter alias.
 *
 * @author Joe Walnes
 */
public class FieldAliasingMapper extends MapperWrapper {

    private final MemberStore<String> fieldToAliasMap = MemberStore.newInstance();
    private final MemberStore<String> aliasToFieldMap = MemberStore.newInstance();
    private final ElementIgnoringMapper elementIgnoringMapper;

    public FieldAliasingMapper(final Mapper wrapped) {
        super(wrapped);
        elementIgnoringMapper = lookupMapperOfType(ElementIgnoringMapper.class);
    }

    public void addFieldAlias(final String alias, final Class<?> type, final String fieldName) {
        fieldToAliasMap.put(type, fieldName, alias);
        aliasToFieldMap.put(type, alias, fieldName);
    }

    /**
     * @deprecated As of 1.4.9 use {@link ElementIgnoringMapper#addElementsToIgnore(Pattern)}.
     */
    @Deprecated
    public void addFieldsToIgnore(final Pattern pattern) {
        if (elementIgnoringMapper != null) {
            elementIgnoringMapper.addElementsToIgnore(pattern);
        }
    }

    /**
     * @deprecated As of 1.4.9 use {@link ElementIgnoringMapper#omitField(Class, String)}.
     */
    @Deprecated
    public void omitField(final Class<?> definedIn, final String fieldName) {
        if (elementIgnoringMapper != null) {
            elementIgnoringMapper.omitField(definedIn, fieldName);
        }
    }

    @Override
    public String serializedMember(final Class<?> type, final String memberName) {
        final String alias = getMember(type, memberName, fieldToAliasMap);
        if (alias == null) {
            return super.serializedMember(type, memberName);
        } else {
            return alias;
        }
    }

    @Override
    public String realMember(final Class<?> type, final String serialized) {
        final String real = getMember(type, serialized, aliasToFieldMap);
        if (real == null) {
            return super.realMember(type, serialized);
        } else {
            return real;
        }
    }

    private String getMember(final Class<?> type, final String name, final MemberStore<String> store) {
        for (Class<?> declaringType = type; declaringType != Object.class && declaringType != null; declaringType =
                declaringType.getSuperclass()) {
            final String member = store.get(declaringType, name);
            if (member != null) {
                return member;
            }
        }
        return null;
    }
}