<filename>xpxchain/models/namespace/alias_type.py
"""
    alias_type
    ==========

    Enumerations for alias types.

    License
    -------

    Copyright 2019 NEM

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
"""

import enum
from ... import util

__all__ = ['AliasType']


@util.inherit_doc
class AliasType(util.U8Mixin, util.EnumMixin, enum.IntEnum):
    """Alias type."""

    NONE = 0
    MOSAIC_ID = 1
    ADDRESS = 2

    def description(self) -> str:
        return DESCRIPTION[self]


DESCRIPTION = {
    AliasType.NONE: "No alias.",
    AliasType.MOSAIC_ID: "Mosaic ID alias.",
    AliasType.ADDRESS: "Address alias.",
}

<filename>xpxchain/models/namespace/alias_type.py
"""
    alias_type
    ==========

    Enumerations for alias types.

    License
    -------

    Copyright 2019 NEM

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
"""

import enum
from ... import util

__all__ = ['AliasType']


@util.inherit_doc
class AliasType(util.U8Mixin, util.EnumMixin, enum.IntEnum):
    """Alias type."""

    NONE = 0
    MOSAIC_ID = 1
    ADDRESS = 2

    def description(self) -> str:
        return DESCRIPTION[self]


DESCRIPTION = {
    AliasType.NONE: "No alias.",
    AliasType.MOSAIC_ID: "Mosaic ID alias.",
    AliasType.ADDRESS: "Address alias.",
}

alias_type     ==========      Enumerations for alias types.      License     -------      Copyright 2019 NEM      Licensed under the Apache License, Version 2.0 (the "License");     you may not use this file except in compliance with the License.     You may obtain a copy of the License at          http://www.apache.org/licenses/LICENSE-2.0      Unless required by applicable law or agreed to in writing, software     distributed under the License is distributed on an "AS IS" BASIS,     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.     See the License for the specific language governing permissions and     limitations under the License. Alias type.