Значение enum как скрытое в C#

Question

У меня есть перечисление, и я хочу «скрыть» одно из его значений (как добавить его для будущей поддержки). Код написан на C#.

public enum MyEnum 
{ 
    ValueA = 0, 

    ValueB = 1, 

    Reserved 
} 

Я не хочу, чтобы люди, использующие этот код, использовали эти значения (MyEnum.Reserved). Любая идея? TIA

Answer 1

Если вы не хотите, чтобы показать его, то не включайте его:

public enum MyEnum 
{ 
    ValueA = 0, 
    ValueB = 1, 
} 

Обратите внимание, что пользователь данного перечисления еще может присвоить любое целое значение переменной, объявленной в MyEnum:

MyEnum e = (MyEnum)2; // works! 

Это означает, что метод, который принимает перечисление всегда должны проверить этот вход перед использованием:

void DoIt(MyEnum e) 
{ 
    if (e != MyEnum.ValueA && e != MyEnum.ValueB) 
    { 
     throw new ArgumentException(); 
    } 

    // ... 
} 

Таким образом, просто добавить значение позже, когда вам это нужно, d измените свои методы, чтобы принять его.

Answer 2

Это невозможно в C#. Все значения перечисления доступны, если доступно Enum.

Единственный способ, которым вы могли бы имитировать это достижение, - использовать менее доступное статическое поле, в котором используется целочисленное значение, которое еще не используется в Enum.

public enum MyEnum { 
    ValueA = 0; 
    ValueB = 1; 
} 

internal static class MyEnumEx { 
    internal static MyEnum Reserved = (MyEnum)42; 
} 

Мне любопытно, но почему вы хотели бы это сделать. Независимо от того, что вы делаете, пользователи все равно могут предоставить значение Reserved. Все, что нужно сделать, - это присвоить int соответствующее значение для типа MyEnum.

// Code that shouldn't access Reserve 
MyEnum reserved = (MyEnum)42; // Woot! 

Answer 3

Вы не можете скрыть, но можете добавить комментарий, который не имеет значения в данный момент. В противном случае просто удалите его и добавьте, если вы добавите поддержку, это не должно нарушать какой-либо другой код, зависящий от него, если исходные значения не изменяются.

Answer 4

Вы можете достичь чего-то как этого, используя свой собственный тип вместо enum:

// This type works pretty much the same way an enum works; 
// each specific value can be cast to/from an int, and each has 
// a specific name that is returned on calling ToString(). 
public sealed class MyEnum 
{ 
    private readonly int _value; 
    private readonly string _name; 

    // private constructor -- ensure that the static members you define below 
    // are the only MyEnum instances accessible from any outside code 
    private MyEnum(int value, string name) 
    { 
     _value = value; 
     _name = name; 
    } 

    // no need to override Equals or GetHashCode, believe it or not -- 
    // one instance per value means we can use reference equality and 
    // that should be just fine 
    public override string ToString() 
    { 
     return _name; 
    } 

    // provide direct access only to these members 
    public static readonly MyEnum ValueA = new MyEnum(0, "ValueA"); 
    public static readonly MyEnum ValueB = new MyEnum(1, "ValueB"); 

    // this member is only available to you within the current assembly 
    internal static readonly MyEnum Reserved = new MyEnum(-1, "Reserved"); 
} 

Вы могли бы еще больше эмулировать поведение enum значений, например, перегрузки explicit операторов для преобразования в/из MyEnum объектов к int ценностей (принял предложение JaredPar, чтобы использовать эту функцию, а не implicit):

public static explicit operator MyEnum(int value) 
{ 
    switch (value) 
    { 
     case 0: 
      return ValueA; 
     case 1: 
      return ValueB; 
     default: 
      throw new InvalidCastException(); 
    } 
} 

public static explicit operator int(MyEnum value) 
{ 
    return value._value; 
} 

Answer 5

Вы можете использовать «Устаревший атрибут» - семантически неправильный, но он будет делать то, что вы хотите:

public enum MyEnum 
{ 
    ValueA = 0, 
    ValueB = 1, 
    [Obsolete("Do not use this", true)] 
    Reserved 
} 

Любой, кто пытается собрать с помощью Foo.Reserved элемент получит ошибку

Answer 6

ARE YOU используя внутреннее «скрытое» значение?В противном случае:

public enum MyEnum 
{ 
    ValueA = 0, 
    ValueB = 1, 
    //TODO: Reserved 
} 

Вы ничего не получаете путем определения неиспользуемой переменной.

Answer 7

, если вы хотите, чтобы скрыть от IntelliSense или PropertyGrid перечисленных членов, вы можете обратиться:

[System.ComponentModel.EditorBrowsable (System.ComponentModel.EditorBrowsableState.Never)]

и

[ System.ComponentModel.Browsable (ложь)]

Пример:

public enum MyEnum 
    { 
    A, 

    B, 
    [System.ComponentModel.Browsable(false)] 
    [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 
    C 
    } 

C не видно

Answer 8

В одну сторону вы можете установить значение этой переменной null. поэтому когда-либо его вызываемый от enum он будет b null. в короткий пользователь не может получить доступ к его значению.

public enum MyEnum 
{ 
    ValueA = 0, 
    ValueB = 1, 

    Reserved.None 
}