/
ordered_maps.go
49 lines (43 loc) · 1.59 KB
/
ordered_maps.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package core
// (C) Copyright IBM Corp. 2024.
//
// 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 (
"gopkg.in/yaml.v2"
)
// OrderedMaps provides a wrapper around the yaml package's
// MapItem type and provides convenience functionality beyond
// what would be available with the MapSlice type, which is similar.
// It enables the ordering of fields in a map for controlling the
// order of keys in the printed YAML strings.
type OrderedMaps struct {
maps []yaml.MapItem
}
// Add appends a key/value pair to the ordered list of maps.
func (m *OrderedMaps) Add(key string, value interface{}) {
m.maps = append(m.maps, yaml.MapItem{
Key: key,
Value: value,
})
}
// GetMaps returns the actual list of ordered maps stored in
// the OrderedMaps instance. Each element is MapItem type,
// which will be serialized by the yaml package in a special
// way that allows the ordering of fields in the YAML.
func (m *OrderedMaps) GetMaps() []yaml.MapItem {
return m.maps
}
// NewOrderedMaps initializes and returns a new instance of OrderedMaps.
func NewOrderedMaps() *OrderedMaps {
return &OrderedMaps{}
}