This topic is copied from Vogen and/or is incomplete. It is being worked on (or is planned
to be worked on).
If you would like to help with this, please see the list of open issues.
Each value object can have its own optional configuration. Examples include:
- The underlying type
- Any ‘conversions’ (Dapper, System.Text.Json, Newtonsoft.Json, etc.) - see Integrations in the wiki for more information
- The type of the exception that is thrown when validation fails
Default values are inferred from global configuration. Global configuration is specified as an assembly level attribute. Here’s an example:
[assembly: VogenDefaults(
underlyingType: typeof(int),
conversions: Conversions.Default,
throws: typeof(ValueObjectValidationException))]
Most values are present in both ValueObject and VogenDefaults. The parameters for the ValueObject attribute are:
underlyingType—the type of the primitive that is being wrapped—defaults to intconversions - specified what conversion code is generated - defaults to Conversions.Default which generates type converters and a converter to handle serialization using System.Text.Jsonthrows = specifies the type of exception thrown when validation fails—defaults to ValueObjectValidationExceptioncustomizations—simple customization switches—defaults to Customizations.None,deserializationStrictness - specifies how strict deserialization is, e.g. should your Validate method be called, or should pre-defined instances that otherwise invalid be allowed - defaults to DeserializationStrictness.AllowValidAndKnownInstancesdebuggerAttributes - specifies the level that debug attributes are written as some IDEs don’t support all of them, e.g., Rider - defaults to DebuggerAttributeGeneration.Full which generates DebuggerDisplay and a debugger proxy type for IDEs that support themcomparison—species which comparison code is generated—defaults to ComparisonGeneration.UseUnderlying which hoists any IComparable implementations from the primitivestringComparers - specifies which string comparison code is generated—defaults to StringComparersGeneration.Omit, which doesn’t generate anything related to string comparison toPrimitiveCasting - specifies the type of casting from wrapper to primitive - defaults to CastOperator.Explicit,fromPrimitiveCasting - specifies the type of casting from primitive to wrapper - default to CastOperator.ExplicitparsableForStrings - specifies what is generated for IParsable types for strings - defaults to ParsableForStrings.GenerateMethodsAndInterfaceparsableForPrimitives - specifies what is generated for Parse and TryParse methods - defaults to ParsableForPrimitives.HoistMethodsAndInterfacestryFromGeneration - specifies what to write for TryFrom methods—defaults to TryFromGeneration.GenerateBoolAndErrorOrMethodsisInitializedMethodGeneration - specifies whether to generate an IsInitialized() method - defaults to IsInitializedMethodGeneration.Generate
The values that are specified only to global configuration are:
systemTextJsonConverterFactoryGeneration - determines whether to write a factory for STJ converters which are useful as a replacement to Reflect in AOT/trimmed scenarios—defaults to SystemTextJsonConverterFactoryGeneration.GeneratestaticAbstractsGeneration - determines whether to write static abstract code - defaults to StaticAbstractsGeneration.OmitopenApiSchemaCustomizations - determines what is generated to assist in OpenAPI scenarios, for instance, generate a schema filter for Swashbuckle, or generate an extension method with MapType calls - defaults to OpenApiSchemaCustomizations.OmitexplicitlySpecifyTypeInValueObject - specifies whether individual value objects should explicitly define the primitive type that they wrap -
defaults to false
Several code analysis warnings exist for invalid configuration, including:
- when you specify an exception that does not derive from
System.Exception
- when your exception does not have one public constructor that takes an int
- when the combination of conversions does not match an entry
