// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.core.util;

import org.litesoft.commonfoundation.typeutils.*;
import org.litesoft.core.simpletypes.nonpublic.*;

public interface HintValidator
{
    /**
     * Note: null for Category means ANY Category
     * Note: null for Group means ANY Group
     */
    public CategoryGroup[] getRegisterForCategoryGroups();

    public String[] getRegisterForHintNames();

    /**
     * @param pName  !null or empty
     * @param pValue !null or empty
     *
     * @return !null is the problem option(s) or section(s)
     */
    public String validate( String pName, String pValue );

    /**
     * Note: null for Category means ANY Category
     * Note: null for Group means ANY Group
     */
    public class CategoryGroup
    {
        private String mCategory;
        private String mGroup;

        public CategoryGroup( String pCategory, String pGroup )
        {
            mCategory = pCategory;
            mGroup = pGroup;
        }

        public String getCategory()
        {
            return mCategory;
        }

        public String getGroup()
        {
            return mGroup;
        }

        public String toString()
        {
            return mCategory + "&" + mGroup;
        }

        public boolean equals( Object o )
        {
            return (o instanceof CategoryGroup) && equals( (CategoryGroup) o );
        }

        public boolean equals( CategoryGroup them )
        {
            return (this == them) || ((them != null) //
                                      && Objects.areNonArraysEqual( this.mCategory, them.mCategory ) //
                                      && Objects.areNonArraysEqual( this.mGroup, them.mGroup ) //
            );
        }

        public int hashCode()
        {
            return EqualSupport.hashCodeEm( EqualSupport.calcHashCode( mCategory ), //
                                            EqualSupport.calcHashCode( mGroup ) );
        }
    }
}