// ------------------------------------------------------------------------
// ℹ️ Project active3
//   Active Thing (activething.com) git.activething.com/go
//
//   File name  field_string.go
// ✍️ Created by DEV
// 📅 Modified   01/05/2024
//
// 🔒 COPYRIGHT  Copyright 2024 activething.com 
// ------------------------------------------------------------------------
// 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.
// ------------------------------------------------------------------------

package aflds

import (
	"ablds"
)

type (

	FieldString struct {
		partialField
		valuerMode
		value 	*string
		valueFn func() string
	}
)

func NewFieldString (name string, value string) *FieldString {
	return &FieldString{
		partialField: makePartialField(name),
		valuerMode:   localValuer{},
		value: &value,
	}
}

func NewDFieldString (name string, valueFn func()string) *FieldString {
	if valueFn == nil {
		panic(G.ErrInvalidDeferFunc)
	}
	return &FieldString{
		partialField: makePartialField(name),
		valuerMode  : deferValuer{},
		valueFn	    : valueFn ,
	}
}

func (f FieldString) getValue() string {
	if f.isLocal() {
		return *f.value
	}
	return f.valueFn()
}


func (f FieldString) Kind () Kind {
	return KindString | f.valuerKind() }

func (f FieldString) Value() any {
	return f.getValue() }


func (f FieldString) String() (string,bool) {
	return f.getValue(),true }


func (f FieldString) Build (builder ablds.Builder) {
	builder.Object(func(b ablds.ObjectBuilder){
		b.Field(f.name).String(f.getValue())
	})
}