SPPAS 4.20

@staticmethod
def validate_id(identifier):
    """Return the given identifier if it matches the requirements.

        An identifier should contain at least 2 characters.

        :param identifier: (str) Key to be validated
        :raises: ValueError
        :returns: (unicode)

        """
    su = sppasUnicode(identifier)
    ide = su.unicode().strip()
    if len(ide) < 1:
        raise FileIdValueError
    return su.unicode()

def get_id(self):
    """Return the identifier (str)."""
    return self.__id

def get_state(self):
    """Return the state (States)."""
    return self._state

def set_state(self, value):
    """Set a state (to be overridden).

        :param value: (States) The state value to assign
        :returns: (bool or list)

        """
    raise NotImplementedError

def match(self, functions, logic_bool='and'):
    """Return True if this instance matches all or any of the functions.

        Functions are defined in a comparator. They return a boolean.
        The type of the value depends on the function.
        The logical not is used to reverse the result of the function.

        :param functions: list of (function, value, logical_not)
        :param logic_bool: (str) Apply a logical "and" or a logical "or" between the functions.
        :returns: (bool)

        """
    matches = list()
    for func, value, logical_not in functions:
        if logical_not is True:
            matches.append(not func(self, value))
        else:
            matches.append(func(self, value))
    if logic_bool == 'and':
        is_matching = all(matches)
    else:
        is_matching = any(matches)
    return is_matching

def __format__(self, fmt):
    """Allow to show the class at a given format.

        :param fmt: (str) the wanted format of string
        :returns: (str)

        """
    return str(self).__format__(fmt)

def __str__(self):
    """The string conversion of the object.

        :returns: (str)

        """
    return '{!s:s}'.format(self.__id)

def __repr__(self):
    """String conversion when called by print.

        :returns: (str) Printed representation of the object.

        """
    return 'File: {!s:s}'.format(self.__id)

def __eq__(self, other):
    """Allows to compare self with other by using "==".

        Compare the identifier, but not the state.

        :param other: (FileName, str)

        """
    if other is not None:
        if isinstance(other, FileBase):
            return self.id == other.id
        else:
            return self.id == other
    return False

def __ne__(self, other):
    """Allows to compare self with other by using "!=".

        Compare the identifier, but not the state.

        :param other: (FileName, str)

        """
    if other is not None:
        return not self == other
    return False

def __gt__(self, other):
    """Allows to compare self with other by using ">".

        Can be used, for example, to sort a list of instances alphabetically.

        :param other: (FileName, str)

        """
    if other is not None:
        return self.id > other.id
    return False

def __lt__(self, other):
    """Allows to compare self with other by using "<".

        Can be used, for example, to sort a list of instances alphabetically.

        :param other: (FileName, str)

        """
    if other is not None:
        return self.id < other.id
    return False

def __hash__(self):
    return hash((self.get_state(), self.get_id()))